メインコンテンツまでスキップ

CLI リファレンス

すべてのコマンドは次の形で実行します。

uv run -m obsidian_ai_hub <flag> [options]
# または
python -m obsidian_ai_hub <flag> [options]

引数なしで実行するとヘルプが表示されます。

サーバー​

フラグ引数説明
--serve—Web UI(FastAPI + React)を起動する。
--serve-host文字列待ち受けアドレス。既定 OBSIDIAN_AI_HUB_HOST → 127.0.0.1。
--serve-port整数待ち受けポート。既定 OBSIDIAN_AI_HUB_PORT → 8765。
--debug—開発用。--serve 併用で自動リロード + 詳細ログ。

デイリーノート​

フラグ引数説明
--merge-inbox—Inbox をデイリーノートへ取り込む。
--make-target—今日の目標を生成して書き込む。
--write-today-schedule—カレンダー / リマインダーの予定を今日のノートへ書き出す。

サマリ・レビュー​

フラグ引数説明
--summerize-day—日次サマリを生成する。
--day-dateYYYY-MM-DD--summerize-day の対象日。
--summerize-week—週次サマリを生成する。
--week-dateYYYY-MM-DD--summerize-week の対象週の任意の日。
--summerize-month—月次サマリを生成する(既定は前月)。
--monthYYYY-MM--summerize-month の対象月。
--review-draft—週次ノートへレビュー下書きを保存し LINE 通知する。
--review-week-dateYYYY-MM-DD--review-draft の対象週。

予定・通知​

フラグ引数説明
--notify-today-schedule—今日の予定を LINE へ通知する。
--generate-planner-proposals—AI プランナー提案を生成して保存・通知する。0件は正常。
--planner-dry-run—AI プランナー提案を検証だけ行い、候補と棄却理由を表示する(保存・通知しない)。

バックアップ・同期​

フラグ引数説明
--backup—指定フォルダを rsync でバックアップする。
--sync-vault—Vault を md-hybrid-search インデックスへ同期する(未指定なら全 Vault を ID 順に同期)。
--rebuild-vault—Vault インデックスを完全に再構築する(未指定なら全 Vault)。
--vaultVault ID(反復可)--sync-vault / --rebuild-vault / --vault-search / --vault-write の対象 Vault。--vault-write には最大1件。
--sync-knowledge—Vault を Open WebUI のナレッジベースへ同期する。
--sync-people—人物候補・重複を正規レコードへ統合する。

リサーチ​

フラグ引数説明
--research-agent—テーマを即時リサーチして保存する。--theme が必須。
--add-research-theme—リサーチ候補テーマに追加する。
--suggest-research-theme—Task Agent にテーマ提案を投入する。
--theme文字列--research-agent / --add-research-theme のテーマ。
--direction文字列--add-research-theme の調査方向(任意)。
--context文字列--research-agent の補足文脈(project / auto-project 経路では無視されます)。
--output-styleshort / medium / long--research-agent の出力長。
--research-modeauto / internal / web / deep / project調査モード(既定 auto)。project は --project-id が必要。project モードは対象リポジトリを読み取り専用でコード調査し、その調査結果を GPT Researcher の最終調査に渡す二段階処理を行います。
--project-id整数--coding の新規セッション、または --research-agent --research-mode project の対象プロジェクト。

--research-agent / --add-research-theme / --suggest-research-theme は相互に排他的です。

メモリ​

フラグ引数説明
--memory-extract—週次ノートとAIエージェントのWebチャット会話から長期メモリ候補を抽出する。
--weekYYYY-MM-DD--memory-extract の対象週。
--memory-interview—インタビュー質問を生成して HITL に登録する。
--memory-interview-weekYYYY-MM-DD--memory-interview の対象週。
--memory-review—候補をレビューする。--id と --approve / --reject / --edit のいずれかが必須。
--id文字列対象メモリ ID。
--approve / --reject—承認 / 却下。
--edit—編集して承認する。--content が必要。
--content文字列--edit の新しい本文。
--memory-delete—メモリを完全削除する。--id が必要。--yes で確認を省略。
--yes—削除の確認プロンプトを省略する。
--memory-compile—コンパイルされるメモリ文脈を確認する。--for が必要。
--for文字列--memory-compile の用途(例 make-target)。
--render-copilot-profile—Copilot プロファイル(7 ファイル)を生成・上書きする。
--memory-maintain—承認済みメモリのメンテナンスを手動実行する。
--rebuild-retrieval-index—長期記憶の Retrieval 検索インデックスを再構築する(初回・埋め込みモデル変更後)。

システムメンテナンス​

フラグ引数説明
--system-maintenance—CLI 実行ログと LLM コール履歴の失敗を診断し、改善提案を HITL に登録する。

設定(対象プロジェクト ID など)は システムメンテナンス診断 を参照してください。

ヘルスケア​

フラグ引数説明
--import-apple-health—Apple Health エクスポートを取り込む。
--healthcare-export-dirパスエクスポートディレクトリ。
--healthcare-batch-size整数コミットのバッチサイズ。
--healthcare-dry-run—書き込まずに件数だけ数える。

--healthcare-* は --import-apple-health と併用します。

キャプチャ・活動・検索​

フラグ引数説明
--screenshot—macOS の画面をキャプチャして Inbox へ保存する。
--display整数--screenshot のディスプレイ番号(既定 1)。
--scan-line-inbox—最前面の LINE から未読候補を抽出する。
--log-activity—活動ログを記録する。
--vault-search—Vault を検索する。--query が必須(--vault 未指定なら全 Vault を横断検索)。
--query文字列検索クエリ。
--k整数結果件数(既定 10)。
--search-modesimilarity / keyword / hybrid検索モード(既定 hybrid)。
--json—JSON で出力する(--vault-search / --coding)。

クリーンアップ​

フラグ説明
--cleanup-line-webhooks30 日より古い LINE webhook を削除する。
--cleanup-execution-logs30 日より古い実行ログと、前日以前に作成され、メッセージがない「新しい会話」の Web chat セッション、最終更新から 24 時間経過した一時会話セッションを削除する。

エージェント・コーディング​

フラグ引数説明
--agent-chat—既存 AI エージェントへ 1 ターンのメッセージを送る。--agent-id が必須。
--agent-id文字列対象エージェント ID。
--agent-prompt文字列メッセージ本文。省略時は stdin を使用。
--resume-session文字列再開するセッション ID。
--agent-outputtext / json--agent-chat の出力形式。
--coding—コーディングを単発実行する。
prompt位置引数コーディングのプロンプト。
--task-agent文字列自由文の依頼を Task Agent に投入する。

Workflow 操作​

エージェントやスクリプトから Workflow を HTTP なしで操作します。結果は JSON で stdout に 出力されます。--workflow-import/validate/publish/run は同時に指定できません。

フラグ引数説明
--workflow-importパス定義 package(JSON / YAML)を新規 Workflow + draft として取り込む。検証エラーがあると終了コード 1。
--workflow-validateRevision ID静的検証を実行し errors / warnings を表示する。
--workflow-publishRevision ID検証済み draft を公開する。
--workflow-runRevision IDpublished Revision から Run を作成する。completed のときだけ終了コード 0。
--workflow-inputNAME=VALUERun 入力(複数可。値は JSON として解釈)。
--workflow-approve—作成した Run を承認して queued にする。
--workflow-wait—終端または人間待ちになるまでポーリングする。
--workflow-execute—Run をこのプロセスで実行する(隔離環境向け。対象 Run だけを claim する)。
--workflow-timeout秒--workflow-wait の最大待機秒(既定 1800)。
uv run python -m obsidian_ai_hub --workflow-import /tmp/wf.json
uv run python -m obsidian_ai_hub --workflow-validate wrev_xxx
uv run python -m obsidian_ai_hub --workflow-publish wrev_xxx
uv run python -m obsidian_ai_hub --workflow-run wrev_xxx \
--workflow-input focus=all --workflow-approve --workflow-wait

Agent 作成 / Vault 書き込み​

フラグ引数説明
--agent-createJSON パスAgent を作成する(name / system_prompt 必須、tool_ids / provider / model / default_vault_ids など任意)。
--vault-write相対パスVault 内の Markdown を書き込む(.md のみ、Vault 外・.. は拒否。--vault 未指定なら primary Vault)。
--vault-contentファイル内容ファイル。- または未指定で stdin。
--vault-overwrite—既存ファイルを上書きする(未指定時は既存があると失敗)。

Gmail 認可​

フラグ説明
--gmail-authorizeGmail OAuth 認可をローカルブラウザで対話的に実行し、トークンを保存する(単独実行専用)。

承認待ち(HITL)​

フラグ説明
--hitl-dispatchHITL を 1 回スキャンして処理する(手動復旧用)。
--hitl-worker常駐 HITL ワーカーを起動する。

テストモード​

ENV=test uv run python -m obsidian_ai_hub --merge-inbox

次に読む​