Перейти до основного вмісту

openclaw docs

Шукайте в актуальному індексі документації OpenClaw з термінала. Команда викликає розміщений у Cloudflare API пошуку документації OpenClaw і виводить результати у вашому терміналі.

Використання

openclaw docs                       # print docs entrypoint and example search
openclaw docs <query...>            # search the live docs index
Аргументи:
АргументОпис
[query...]Пошуковий запит у вільній формі. Багатослівні запити об’єднуються пробілами й надсилаються як один.

Приклади

openclaw docs browser existing-session
openclaw docs sandbox allowHostControl
openclaw docs gateway token secretref
Без запиту openclaw docs виводить URL точки входу до документації та приклад команди пошуку замість запуску пошуку.

Як це працює

openclaw docs викликає https://docs.openclaw.ai/api/search і відображає результати JSON. Пошуковий виклик використовує фіксований тайм-аут 30 секунд.

Вивід

У функціональному (TTY) терміналі результати відображаються як заголовок, за яким іде маркований список. Кожен пункт показує назву сторінки, пов’язаний URL документації і короткий фрагмент у наступному рядку. Для порожніх результатів виводиться “Немає результатів.”. У нефункціональному виводі (переданому через канал, --no-color, скрипти) ті самі дані відображаються як Markdown:
# Docs search: <query>

- [Title](https://docs.openclaw.ai/...) - snippet
- [Title](https://docs.openclaw.ai/...) - snippet

Коди виходу

КодЗначення
0Пошук виконано успішно (зокрема відповіді з нульовою кількістю результатів).
1Виклик розміщеного API пошуку документації не вдався; stderr виводиться безпосередньо.

Пов’язане