> ## Documentation Index > Fetch the complete documentation index at: https://docs.shannon.run/llms.txt > Use this file to discover all available pages before exploring further. # CLIリファレンス > Shannon CLI 完全リファレンス - ターミナルからタスク送信、イベントストリーミング、セッション管理、スケジュール管理など ## インストール ```bash theme={"dark"} pip install shannon-sdk ``` `shannon` コマンドがインストールされます。確認： ```bash theme={"dark"} shannon --help ``` ソースから（開発）: ```bash theme={"dark"} git clone https://github.com/Kocoro-lab/Shannon.git cd Shannon/clients/python pip install -e . ``` ## 接続 ### ローカル（セルフホスト） ```bash theme={"dark"} shannon --base-url http://localhost:8080 submit "Hello world" --wait ``` ### Shannon Cloud [https://shannon.run](https://shannon.run) で登録してAPIキーを取得： ```bash theme={"dark"} shannon --base-url http://localhost:8080 --api-key YOUR_API_KEY \ submit "Hello world" --wait ``` ### 環境変数 毎回フラグを渡さないように設定： ```bash theme={"dark"} export SHANNON_BASE_URL=http://localhost:8080 # または http://localhost:8080 export SHANNON_API_KEY=sk_your_key_here # export SHANNON_BEARER_TOKEN=eyJ... # APIキーの代替 ``` 設定後： ```bash theme={"dark"} shannon submit "Hello world" --wait ``` | 変数 | デフォルト | 説明 | | ---------------------- | ----------------------- | ------------------------ | | `SHANNON_BASE_URL` | `http://localhost:8080` | ゲートウェイURL | | `SHANNON_API_KEY` | (なし) | APIキー認証（`X-API-Key`ヘッダー） | | `SHANNON_BEARER_TOKEN` | (なし) | Bearerトークン認証（APIキーの代替） | ## グローバルオプション コマンド名の前に指定： ```bash theme={"dark"} shannon [--base-url URL] [--api-key KEY] [--bearer-token TOKEN] COMMAND [OPTIONS] ``` *** ## タスク ### submit - タスク送信 ```bash theme={"dark"} shannon submit QUERY [OPTIONS] ``` **引数：** | 引数 | 必須 | 説明 | | ------- | -- | --------- | | `QUERY` | はい | タスククエリ文字列 | **オプション：** | フラグ | 型 | 説明 | | ------------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `--wait` | flag | タスク完了まで待機し結果を表示 | | `--session-id` | string | セッションに紐付け | | `--mode` | `simple` \| `standard` \| `complex` \| `supervisor` | 実行モード | | `--model-tier` | `small` \| `medium` \| `large` | モデルティア | | `--model-override` | string | 特定モデル指定（例: `gpt-5-nano-2025-08-07`） | | `--provider-override` | string | プロバイダー指定: `openai`, `anthropic`, `google`, `groq`, `xai`, `deepseek`, `qwen`, `zai`, `ollama`, `mistral`, `cohere` | | `--force-research` | flag | ResearchWorkflow（引用付き）を強制 | | `--research-strategy` | `quick` \| `standard` \| `deep` \| `academic` | リサーチ戦略 | | `--max-iterations` | int (1-50) | 最大リサーチ反復回数を上書き | | `--max-concurrent-agents` | int (1-20) | 最大同時エージェント数を上書き | | `--enable-verification` | flag | クレーム検証を有効化 | | `--disable-verification` | flag | クレーム検証を無効化 | | `--enable-citations` | flag | 引用収集を有効化 | | `--disable-citations` | flag | 引用収集を無効化 | | `--swarm` | flag | マルチエージェントswarmワークフローを強制 | | `--idempotency-key` | string | 重複送信を防止 | | `--traceparent` | string | W3C traceparent 分散トレーシング | **例：** ```bash theme={"dark"} # シンプルなタスク shannon submit "2+2は？" --wait # ディープリサーチ（引用付き） shannon submit "量子コンピューティングの最新進展" \ --force-research --research-strategy deep --wait # コスト最適化 shannon submit "このテキストを要約" --model-tier small --mode simple --wait # モデルとプロバイダーを指定 shannon submit "トレンドを分析" --model-override gpt-5-nano-2025-08-07 --provider-override openai --wait # マルチエージェントswarm shannon submit "AI ワークロード向けトップ3クラウドプロバイダーを比較" --swarm --wait # セッションに紐付け shannon submit "フォローアップ質問" --session-id my-session --wait ``` ### status - タスクステータス取得 ```bash theme={"dark"} shannon status TASK_ID ``` ### cancel - タスクキャンセル ```bash theme={"dark"} shannon cancel TASK_ID [--reason REASON] ``` ### pause - タスク一時停止 次のワークフローチェックポイントで一時停止します（即時ではありません）。 ```bash theme={"dark"} shannon pause TASK_ID [--reason REASON] ``` ### resume - 一時停止中のタスクを再開 ```bash theme={"dark"} shannon resume TASK_ID [--reason REASON] ``` ### control-state - 一時停止/キャンセル状態を取得 ```bash theme={"dark"} shannon control-state TASK_ID ``` *** ## ストリーミング ### stream - SSEでタスクイベントをストリーミング ```bash theme={"dark"} shannon stream WORKFLOW_ID [OPTIONS] ``` | フラグ | 型 | 説明 | | --------------- | ------ | ------------------------ | | `--types` | string | カンマ区切りのイベントタイプフィルター | | `--traceparent` | string | W3C traceparent 分散トレーシング | **イベントタイプ：** `WORKFLOW_STARTED`, `WORKFLOW_COMPLETED`, `LLM_PROMPT`, `LLM_PARTIAL`, `LLM_OUTPUT`, `TOOL_INVOKED`, `TOOL_OBSERVATION`, `APPROVAL_REQUESTED`, `APPROVAL_DECISION`, `ERROR_OCCURRED` ```bash theme={"dark"} # 全イベントをストリーミング shannon stream workflow-xyz789 # LLM出力と完了イベントのみ shannon stream workflow-xyz789 --types LLM_OUTPUT,WORKFLOW_COMPLETED ``` *** ## HITLレビュー（Human-in-the-Loop） ### review-get - レビュー状態を取得 ```bash theme={"dark"} shannon review-get WORKFLOW_ID ``` ### review-feedback - フィードバック送信 ```bash theme={"dark"} shannon review-feedback WORKFLOW_ID MESSAGE [--version N] ``` ### review-approve - レビュープランを承認 ```bash theme={"dark"} shannon review-approve WORKFLOW_ID [--version N] ``` ### approve - 承認リクエストの承認/拒否 ```bash theme={"dark"} shannon approve APPROVAL_ID WORKFLOW_ID [--approve | --reject] [--feedback TEXT] ``` `--approve` がデフォルト。拒否するには `--reject` を使用。 ```bash theme={"dark"} # 承認 shannon approve approval-001 workflow-xyz789 --feedback "問題なし" # 拒否 shannon approve approval-001 workflow-xyz789 --reject --feedback "修正が必要" ``` *** ## セッション ### session-list - セッション一覧 ```bash theme={"dark"} shannon session-list [--limit N] [--offset N] ``` ### session-get - セッション詳細 ```bash theme={"dark"} shannon session-get SESSION_ID [--no-history] ``` ### session-title - セッションタイトル更新 ```bash theme={"dark"} shannon session-title SESSION_ID TITLE ``` ### session-delete - セッション削除 ```bash theme={"dark"} shannon session-delete SESSION_ID ``` *** ## スケジュール ### schedule-create - 定期タスク作成 ```bash theme={"dark"} shannon schedule-create NAME CRON QUERY [OPTIONS] ``` | フラグ | デフォルト | 説明 | | --------------------- | ----- | --------------------------------------------- | | `--description` | (なし) | 説明 | | `--timezone` | `UTC` | タイムゾーン | | `--force-research` | オフ | リサーチモードを有効化 | | `--research-strategy` | (なし) | `quick` \| `standard` \| `deep` \| `academic` | | `--budget` | (なし) | 実行ごとの最大予算（USD） | | `--timeout` | (なし) | 実行ごとのタイムアウト（秒） | **Cron式：** ``` 分 時 日 月 曜日 0 9 * * 1-5 = 平日9:00 0 */4 * * * = 4時間ごと 0 0 * * 1 = 毎週月曜日0:00 ``` ```bash theme={"dark"} shannon schedule-create "毎日AIニュース" "0 9 * * *" "最新AIニュース要約" \ --timezone Asia/Tokyo --force-research --research-strategy quick ``` ### schedule-list - スケジュール一覧 ```bash theme={"dark"} shannon schedule-list [--page N] [--page-size N] [--status ACTIVE|PAUSED] ``` ### schedule-get - スケジュール詳細 ```bash theme={"dark"} shannon schedule-get SCHEDULE_ID ``` ### schedule-update - スケジュール更新 ```bash theme={"dark"} shannon schedule-update SCHEDULE_ID [--name N] [--cron C] [--query Q] [--timezone T] [--budget B] [--timeout T] [--clear-context] ``` ### schedule-pause - スケジュール一時停止 ```bash theme={"dark"} shannon schedule-pause SCHEDULE_ID [--reason REASON] ``` ### schedule-resume - スケジュール再開 ```bash theme={"dark"} shannon schedule-resume SCHEDULE_ID [--reason REASON] ``` ### schedule-delete - スケジュール削除 ```bash theme={"dark"} shannon schedule-delete SCHEDULE_ID ``` ### schedule-runs - 実行履歴 ```bash theme={"dark"} shannon schedule-runs SCHEDULE_ID [--page N] [--page-size N] ``` *** ## ツール ### tools-list - 利用可能なツール一覧 ```bash theme={"dark"} shannon tools-list [--category CATEGORY] ``` **例：** ```bash theme={"dark"} shannon tools-list ``` **出力：** ``` Name Description -------------------------------------------------------------------------------- web_search Search the web for information calculator Evaluate mathematical expressions ``` ### tool-get - ツール詳細 ```bash theme={"dark"} shannon tool-get NAME ``` **例：** ```bash theme={"dark"} shannon tool-get web_search ``` ### tool-exec - ツールを直接実行 ```bash theme={"dark"} shannon tool-exec NAME [--arguments JSON] [--session-id ID] ``` | フラグ | 型 | 説明 | | -------------- | ------- | ----------------------------- | | `--arguments` | JSON文字列 | ツール引数（JSONオブジェクト、デフォルト: `{}`） | | `--session-id` | string | オプションのセッションID（ツールコンテキスト用） | **例：** ```bash theme={"dark"} shannon tool-exec web_search --arguments '{"query": "Shannon AI"}' ``` *** ## エージェント ### agents-list - 確定的エージェント一覧 ```bash theme={"dark"} shannon agents-list ``` ### agent-get - エージェント詳細 ```bash theme={"dark"} shannon agent-get AGENT_ID ``` ### agent-exec - 確定的エージェントを実行 ```bash theme={"dark"} shannon agent-exec AGENT_ID --input JSON [--session-id ID] [--stream] ``` | フラグ | 型 | 説明 | | -------------- | ------- | -------------------------------- | | `--input` | JSON文字列 | エージェント入力（JSONオブジェクト、デフォルト: `{}`） | | `--session-id` | string | オプションのセッションID | | `--stream` | flag | ストリーミングエージェント実行をリクエスト | **例：** ```bash theme={"dark"} shannon agent-exec agent-001 --input '{"query": "Q4のトレンドを分析"}' ``` ### swarm-message - 実行中のスウォームにメッセージ送信 ```bash theme={"dark"} shannon swarm-message WORKFLOW_ID MESSAGE ``` **例：** ```bash theme={"dark"} shannon swarm-message workflow-xyz789 "コスト分析に焦点を当ててください" ``` *** ## ファイル ### session-files - セッションワークスペースファイル一覧 ```bash theme={"dark"} shannon session-files SESSION_ID [--path SUBDIR] ``` | フラグ | 型 | 説明 | | -------- | ------ | --------------------- | | `--path` | string | オプションのワークスペースサブディレクトリ | **例：** ```bash theme={"dark"} shannon session-files my-session ``` ### session-file-get - ワークスペースファイルをダウンロード ```bash theme={"dark"} shannon session-file-get SESSION_ID PATH ``` **例：** ```bash theme={"dark"} shannon session-file-get my-session report.md ``` ### memory-files - ユーザーメモリファイル一覧 ```bash theme={"dark"} shannon memory-files ``` ### memory-file-get - メモリファイルをダウンロード ```bash theme={"dark"} shannon memory-file-get PATH ``` **例：** ```bash theme={"dark"} shannon memory-file-get profile.md ``` *** ## スキル ### skills-list - 利用可能なスキル一覧 ```bash theme={"dark"} shannon skills-list [--category CATEGORY] ``` ### skill-get - スキル詳細 ```bash theme={"dark"} shannon skill-get NAME ``` ### skill-versions - スキルバージョン一覧 ```bash theme={"dark"} shannon skill-versions NAME ``` *** ## 終了コード | コード | 意味 | | --- | ----------------------- | | 0 | 成功 | | 1 | エラー（タスク失敗、APIエラー、引数エラー） |