コマンドリファレンス

すべての NovitaClaw CLI コマンドの完全なリファレンスです。

`launch`

新しい sandbox インスタンスを作成します。

Bash

novitaclaw launch [OPTIONS]

オプション	説明
`--api-key`	Novita API key
`--gateway-token`	カスタム gateway token（任意、デフォルトでは自動生成）
`--timeout`	作成タイムアウト（秒）（デフォルト: `60`）
`--type`	Sandbox タイプ: `persistent`（デフォルト）または `on-demand`
`--idle-timeout`	オンデマンドモードのアイドルタイムアウト（秒）（デフォルト: `300`、範囲: 60–86400）

`list`

アクティブな sandbox インスタンスを一覧表示します。

Bash

novitaclaw list --api-key YOUR_API_KEY

オプション	説明
`--api-key`	Novita API key
`--quiet`, `-q`	sandbox ID のみを 1 行に 1 つずつ出力します（スクリプトでの利用に便利）

`status`

sandbox インスタンスのステータスを確認します。設定済みのすべてのチャネルの webhook URL を表示します。

Bash

novitaclaw status <SANDBOX_ID> --api-key YOUR_API_KEY

オプション	説明
`--api-key`	Novita API key
`--json`	JSON 形式で出力します（webhook URL の抽出に便利）

`stop`

sandbox インスタンスを終了します。

Bash

novitaclaw stop <SANDBOX_ID> --api-key YOUR_API_KEY

オプション	説明
`--api-key`	Novita API key
`--yes`, `-y`	確認プロンプトをスキップします

`pause`

sandbox インスタンスを一時停止します。一時停止中は課金がゼロになります。

Bash

novitaclaw pause <SANDBOX_ID> --api-key YOUR_API_KEY

`resume`

一時停止中の sandbox インスタンスを再開します（復元まで約 1 秒）。

Bash

novitaclaw resume <SANDBOX_ID> --api-key YOUR_API_KEY

`config set`

sandbox のランタイム設定を更新します。

Bash

# Update idle timeout (60–86400 seconds)
novitaclaw config set <SANDBOX_ID> idle-timeout 600

# Update sandbox lifetime timeout (300–2592000 seconds)
novitaclaw config set <SANDBOX_ID> timeout 3600

`tui`

ターミナル UI 経由で sandbox に接続します。

Bash

novitaclaw tui <SANDBOX_ID> --token <GATEWAY_TOKEN>

`doctor`

sandbox インスタンスに対して診断と修復チェックを実行します。

Bash

novitaclaw doctor <SANDBOX_ID> --api-key YOUR_API_KEY

オプション	説明
`--api-key`	Novita API key
`--deep`	追加の gateway インストールを探すためにシステムサービスをスキャンします
`--fix`	推奨される修復を適用します（`--repair` のエイリアス）
`--force`	強力な修復を適用します（カスタムサービス設定を上書きします）
`--generate-gateway-token`	gateway token を生成して設定します
`--no-workspace-suggestions`	ワークスペースメモリシステムの提案を無効化します
`--repair`	プロンプトなしで推奨される修復を適用します
`--yes`	プロンプトなしでデフォルトを受け入れます

`gateway update`

sandbox 内の OpenClaw を最新バージョンに更新します。

Bash

novitaclaw gateway update <SANDBOX_ID> --api-key YOUR_API_KEY

オプション	説明
`--api-key`	Novita API key
`--restart`	更新後に gateway を再起動します

`gateway restart`

sandbox 内の OpenClaw Gateway を再起動します。

Bash

novitaclaw gateway restart <SANDBOX_ID> --api-key YOUR_API_KEY

`services setup`

既存の sandbox に Web Terminal と File Manager をインストールして起動します。これらのサービスが含まれる前に起動された古い sandbox にサービスを追加する場合に使用します。

Bash

novitaclaw services setup <SANDBOX_ID> --api-key YOUR_API_KEY

`pair list`

チャネルの保留中のペアリングリクエストを一覧表示します。

Bash

novitaclaw pair list <SANDBOX_ID> --channel <CHANNEL_NAME> --api-key YOUR_API_KEY

`pair approve`

チャネルのペアリングリクエストを承認します。

Bash

novitaclaw pair approve <SANDBOX_ID> --channel <CHANNEL_NAME> --code <PAIRING_CODE> --api-key YOUR_API_KEY

`pair feishu`

Feishu（Lark）をメッセージングチャネルとして設定します。

Bash

novitaclaw pair feishu <SANDBOX_ID> \
  --app-id cli_xxx \
  --app-secret secret_xxx \
  --mode webhook \
  --verification-token tok_xxx \
  --encrypt-key key_xxx

オプション	説明
`--app-id`	Feishu app ID
`--app-secret`	Feishu app secret
`--mode`	`event`（デフォルト）または `webhook`
`--verification-token`	Webhook verification token（webhook モードのみ）
`--encrypt-key`	Webhook encrypt key（webhook モードのみ）
`--webhook-host`	Webhook bind address（デフォルト: `0.0.0.0`）
`--webhook-port`	Webhook listen port（デフォルト: `3000`）
`--webhook-path`	Webhook URL path（デフォルト: `/feishu/events`）

`pair telegram`

Telegram をメッセージングチャネルとして設定します。

Bash

# Polling mode (default)
novitaclaw pair telegram <SANDBOX_ID> \
  --bot-token <BOT_TOKEN>

# Webhook mode
novitaclaw pair telegram <SANDBOX_ID> \
  --bot-token <BOT_TOKEN> \
  --mode webhook \
  --webhook-url https://example.com/webhook/telegram \
  --webhook-secret <SECRET>

オプション	説明
`--bot-token`	BotFather から取得した Telegram bot token
`--mode`	`polling`（デフォルト）または `webhook`
`--webhook-url`	公開 webhook URL（webhook モードのみ）
`--webhook-secret`	Webhook secret（webhook モードのみ）
`--webhook-host`	Webhook bind address（デフォルト: `0.0.0.0`）
`--webhook-port`	Webhook listen port（デフォルト: `8787`）
`--webhook-path`	Webhook URL path（デフォルト: `/webhook/telegram`）
`--dm-policy`	DM policy（デフォルト: `pairing`）

`pair slack`

Slack をメッセージングチャネルとして設定します。

Bash

# Socket mode (default)
novitaclaw pair slack <SANDBOX_ID> \
  --bot-token xoxb-... \
  --app-token xapp-...

# HTTP mode
novitaclaw pair slack <SANDBOX_ID> \
  --bot-token xoxb-... \
  --mode http \
  --signing-secret <SECRET>

オプション	説明
`--bot-token`	Slack bot token（`xoxb-...`）
`--app-token`	Slack app token（`xapp-...`、socket モードのみ）
`--mode`	`socket`（デフォルト）または `http`
`--signing-secret`	Slack signing secret（HTTP モードのみ）
`--webhook-host`	Webhook bind address（デフォルト: `0.0.0.0`）
`--webhook-port`	Webhook listen port（デフォルト: `8788`）
`--webhook-path`	Webhook URL path（デフォルト: `/webhook/slack`）

`update`

CLI の更新を確認し、最新バージョンにアップグレードします。

Bash

novitaclaw update

プログラムからの使用

自動化には JSON 出力を使用します。

Bash

novitaclaw -j launch --api-key YOUR_API_KEY

レスポンス例:

{
  "success": true,
  "data": {
    "sandbox_id": "xxx",
    "webui": "https://xxx.sandbox.novita.ai?token=xxx",
    "gateway_ws": "wss://xxx.sandbox.novita.ai",
    "gateway_token": "xxx",
    "terminal_url": "https://7681-xxx.sandbox.novita.ai",
    "filemanager_url": "https://7682-xxx.sandbox.novita.ai",
    "services_username": "admin",
    "services_password": "xxx"
  }
}

環境変数

変数	説明
`NOVITA_API_KEY`	API key。`--api-key` フラグを指定する必要がなくなります
`OPENCLAW_GATEWAY_TOKEN`	事前設定済みの gateway token

トラブルシューティング

コマンドが見つからない

次のいずれかを試してください。

Bash

# Use full path (Linux)
~/.local/bin/novitaclaw launch

# Typical macOS user path
~/Library/Python/3.x/bin/novitaclaw launch

接続タイムアウト

起動タイムアウトを増やします。

Bash

novitaclaw launch --timeout 180 --api-key YOUR_API_KEY

よくある質問

問題	発生する理由	対処方法
”Command not found” / “Not recognized”	インストール時に Python PATH が設定されていない	Python を再インストールし、“Add to PATH” にチェックを入れるか、bin ディレクトリを手動で追加します
”Permission Denied”	権限が不足しています	Windows: Terminal を管理者として実行します。Mac/Linux: `sudo` を先頭に付けます
”Invalid API Key”	key が正しくコピーされていません	`sk_` 文字列の前後に余分なスペースがないか確認するか、新しい key を生成します
Sandbox が停止しない	誤削除を防ぐために確認が必要です	プロンプトが表示されたら `y` と入力するか、`--yes` を使用して確認をスキップします
Mac: `pip` command not found	macOS はデフォルトで `pip3` を使用します	`pip` の代わりに `pip3 install novitaclaw` を使用します

Get started

Model APIs

Agent Sandbox

GPUs

Observability

Resources

コマンドリファレンス

`launch`

`list`

`status`

`stop`

`pause`

`resume`

`config set`

`tui`

`doctor`

`gateway update`

`gateway restart`

`services setup`

`pair list`

`pair approve`

`pair feishu`

`pair telegram`

`pair slack`

`update`

プログラムからの使用

環境変数

トラブルシューティング

コマンドが見つからない

接続タイムアウト

よくある質問

​launch

​list

​status

​stop

​pause

​resume

​config set

​tui

​doctor

​gateway update

​gateway restart

​services setup

​pair list

​pair approve

​pair feishu

​pair telegram

​pair slack

​update

​プログラムからの使用

​環境変数

​トラブルシューティング

​コマンドが見つからない

​接続タイムアウト

​よくある質問

`launch`

`list`

`status`

`stop`

`pause`

`resume`

`config set`

`tui`

`doctor`

`gateway update`

`gateway restart`

`services setup`

`pair list`

`pair approve`

`pair feishu`

`pair telegram`

`pair slack`

`update`

プログラムからの使用

環境変数

トラブルシューティング

コマンドが見つからない

接続タイムアウト

よくある質問