CLI commands

文件

openclaw docs

從終端機搜尋即時 OpenClaw 文件索引。此命令會呼叫 OpenClaw 由 Cloudflare 託管的文件搜尋 API,並在你的終端機中呈現結果。

用法

bash
openclaw docs                       # print docs entrypoint and example searchopenclaw docs <query...>            # search the live docs index

引數:

引數 說明
[query...] 自由格式搜尋查詢。多字詞查詢會以空格合併,並作為一筆查詢送出。

範例

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

沒有查詢時,openclaw docs 會列印文件入口 URL 加上一個範例搜尋命令,而不是執行搜尋。

運作方式

openclaw docs 會呼叫 https://docs.openclaw.ai/api/search 並呈現 JSON 結果。搜尋呼叫使用固定 30 秒逾時。

輸出

在功能豐富的 (TTY) 終端機中,結果會呈現為標題,後接項目符號清單。每個項目符號會顯示頁面標題、連結的文件 URL,以及下一行的簡短片段。空結果會列印「No results.」。

在非豐富輸出(管線傳遞、--no-color、腳本)中,相同資料會呈現為 Markdown:

markdown
# Docs search: <query> - [Title](https://docs.openclaw.ai/...) - snippet- [Title](https://docs.openclaw.ai/...) - snippet

結束代碼

代碼 含義
0 搜尋成功(包含零結果回應)。
1 託管的文件搜尋 API 呼叫失敗;stderr 會內嵌列印。

相關

Was this useful?
On this page

On this page