Перейти к основному содержанию

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 выводится inline.

Связанные материалы