CLI commands

Документація

`openclaw docs`

Пошук в актуальному індексі документації OpenClaw із термінала.

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

bash

openclaw docs                       # вивести точку входу до документації та приклад пошукуopenclaw docs <query...>            # шукати в актуальному індексі документації

Аргумент	Опис
`[query...]`	Пошуковий запит у довільній формі. Запити з кількох слів об’єднуються пробілами й надсилаються як один.

Якщо запит не вказано, openclaw docs замість виконання пошуку виводить URL точки входу до документації та приклад команди пошуку.

Приклади

bash

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

Як це працює

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

Виведення

У терміналі з розширеним форматуванням (TTY) результати відображаються як заголовок із подальшим маркованим списком: назва сторінки, URL-посилання на документацію та короткий фрагмент у наступному рядку. Якщо результатів немає, виводиться «Результатів немає.».

У режимі простого виведення (через конвеєр, із --no-color, у скриптах) ті самі дані відображаються у форматі Markdown:

markdown

# Пошук у документації: <query> - [Назва](https://docs.openclaw.ai/...) - фрагмент- [Назва](https://docs.openclaw.ai/...) - фрагмент

Коди завершення

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

Пов’язані матеріали

Was this useful?