CLI commands

ドキュメント

openclaw docs

ターミナルから公開中の OpenClaw ドキュメントインデックスを検索します。

使用方法

bash
openclaw docs                       # ドキュメントのエントリーポイントと検索例を表示openclaw docs <query...>            # 公開中のドキュメントインデックスを検索
引数 説明
[query...] 自由形式の検索クエリ。複数単語のクエリはスペースで結合され、1 つのクエリとして送信されます。

クエリを指定しない場合、openclaw docs は検索を実行せず、ドキュメントのエントリーポイント URL と検索コマンドの例を表示します。

bash
openclaw docs browser existing-sessionopenclaw docs sandbox allowHostControlopenclaw docs gateway token secretref

仕組み

openclaw docshttps://docs.openclaw.ai/api/search を呼び出し、JSON の結果を表示します。検索リクエストには固定の 30 秒のタイムアウトが設定されています。

出力

リッチ(TTY)ターミナルでは、結果は見出しに続く箇条書きとして表示されます。各項目にはページタイトル、リンク付きのドキュメント URL、その次の行に短い抜粋が表示されます。結果が空の場合は「結果がありません。」と表示されます。

非リッチ出力(パイプ、--no-color、スクリプト)では、同じデータが Markdown として表示されます。

markdown
# ドキュメント検索: <query> - [タイトル](https://docs.openclaw.ai/...) - 抜粋- [タイトル](https://docs.openclaw.ai/...) - 抜粋

終了コード

コード 意味
0 検索に成功しました。結果が 0 件の応答も含まれます。
1 ホストされているドキュメント検索 API の呼び出しに失敗し、stderr にエラーメッセージが表示されました。

関連項目

Was this useful?
On this page

On this page