インストール
npx skills add openclaw/crabbox --skill crabboxCrabbox は、coding agent がローカルのコードを編集している横で、テスト・ビルド・UI チェックを必要なときにすぐ使えるリモートマシンに任せて実行するのに最も適しています。使い始める前に最も重要な前提条件は、CLI を自分のマシンにインストールできること、そしてローカルコンテナのクイックパスを使う場合は Docker または Podman を事前にインストールして起動しておくことです。
向いている人
- agent や自分自身が、クラウドボックス、ローカル VM/コンテナ、あるいは既に持っているマシン上でテスト・ビルド・UI チェックを実行しながら、コード編集はローカルで続けたい人に向いています。
- Crabbox は CLI であり、3 つの形態のボックスを提供します:クラウドボックス、ローカル VM またはコンテナ、そして自分が既に持っているマシンです。
- ローカルコンテナのクイックパスには、Docker または Podman がインストールされ起動していることが必要です。SSH ワークフローを使う場合は、ローカルに
git、ssh、ssh-keygen、rsync、curlが必要です。これらの前提条件を満たさない場合、他の利用方法が公式のエビデンスでは示されていません。 - クラウドボックスにアカウントが必要か、課金体系、対応するクラウドプラットフォームについては、エビデンスに記載がないため、利用前に公式ドキュメントで自分で確認する必要があります。
3 分で最初の試用を完了する
推奨される公式のメインパスはローカルコンテナのクイックスタートで、全工程でクラウドアカウントは不要です:
-
前提:Docker または Podman をインストールして起動しておく。CLI は別途インストールします(公式の説明は "Install the CLI separately"。具体的なインストールコマンドは公式 README を参照してください)。
-
agent スキルをインストール:対応している agent で公式コマンドを実行します:
npx skills add openclaw/crabbox --skill crabbox公式は
crabbox-quickstartというスキルも公開しており、代替として使えます。 -
信頼できる Git リポジトリに入ります(公式は信頼できるリポジトリ内での操作を求めています)。
-
agent(またはターミナル)に公式のセルフチェックコマンドを実行させます:
crabbox doctor --provider local-container成功のサイン:
doctorがローカルコンテナ環境のチェックを通過すること。 -
次に、低リスクで読み取り専用の最初のタスクを実行し、全体のパイプラインを検証します:
crabbox run --provider local-container -- uname -a成功のサイン:Crabbox が使い捨てのコンテナボックスをレンタルし、コマンドの出力をターミナルにストリーミングして返し、その後ボックスを解放します。この例では
uname -aを実行するだけで、ファイルは変更されません。 -
以降の中心的なワークフローは
crabbox run -- <cmd>です:ボックスをレンタルし、作業ツリー(未コミットの変更を含む)を同期し、コマンドを実行して出力をターミナルにストリーミングし、終了コードを返した後、使い捨てのボックスを解放します。注意:同期されるのは未コミットの変更を含む作業ツリー全体です。初めて実際のテストコマンドを実行する前に、ボックスに持ち込まれて実行される内容を理解しているか確認してください。
使用例
例 1:コミット前にクリーンなボックスでテストスイートを実行。シナリオ:自分(または agent)がコードを変更したが、ローカル環境を汚したくない場合。agent に crabbox run -- pnpm test を実行させます(pnpm test は自分のプロジェクトのテストコマンドに置き換えてください)。期待できる結果:使い捨てのボックスがレンタルされ、未コミットの変更を含む作業ツリーが同期され、テスト出力がリアルタイムでターミナルにストリーミングされ、終了後に実際の終了コードが得られ、ボックスが解放されます。
例 2:コンテナボックス環境の検証。シナリオ:初回のセットアップ時や環境に問題があると疑う場合。まず agent に crabbox doctor --provider local-container を実行させて診断し、次に crabbox run --provider local-container -- uname -a を実行してボックスがコマンドを実行できることを確認します。期待できる結果:doctor はローカルコンテナ環境が準備できているかどうかを報告し、run はボックスのシステム情報を返し、レンタル—同期—実行—回収の完全なパイプラインが動作することを証明します。この 2 つの操作はチェックとシステム情報の読み取りのみを行う、典型的な低リスクの初回利用アクションです。
利用上の境界
- 副作用と確認ポイント:毎回の
crabbox runはボックスをレンタルし、作業ツリー(未コミットの変更を含む)をそのボックスに同期した上で、指定したコマンドをその中で実行します。コマンドはボックス内で実際に実行されるため、実行前にコマンドの内容を確認してください。ローカルコンテナパスでは自分のマシン上でコンテナも起動されます。クラウドボックスに関わる外部サービスの境界については、エビデンスに記載がありません。 - 実行環境の前提:ローカルコンテナのクイックパスには Docker または Podman が必要。SSH ワークフローにはローカルに
git、ssh、ssh-keygen、rsync、curlが必要です。 - クライアントの前提:スキルは
npx skills addでインストールされ、agent skills に対応した agent で利用できます。具体的にどのクライアントが対応しているかは、エビデンスでは個別に列挙されていません。 - 未確認の重要情報:クラウドボックスの開通とアカウント要件、
crabbox doctorやrunがネットワークにアクセスするか、どのローカルファイルを読み書きするか、ドキュメントに示されたコマンド以外にどのサブコマンドがあるかについては、公式のエビデンスに記載がなく、利用前に公式 README を参照してください。