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?