CLI commands

Documentação

`openclaw docs`

Pesquise o índice de documentação ativo do OpenClaw pelo terminal. O comando chama a API de busca da documentação do OpenClaw hospedada na Cloudflare e renderiza os resultados no seu terminal.

Uso

bash

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

Argumentos:

Argumento	Descrição
`[query...]`	Consulta de busca em formato livre. Consultas com várias palavras são unidas com espaços e enviadas como uma só.

Exemplos

bash

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

Sem consulta, openclaw docs imprime a URL de entrada da documentação mais um comando de busca de exemplo em vez de executar uma busca.

Como funciona

openclaw docs chama https://docs.openclaw.ai/api/search e renderiza os resultados JSON. A chamada de busca usa um tempo limite fixo de 30 segundos.

Saída

Em um terminal rico (TTY), os resultados são renderizados como um título seguido por uma lista com marcadores. Cada marcador mostra o título da página, a URL vinculada da documentação e um trecho curto na linha seguinte. Resultados vazios imprimem "Nenhum resultado.".

Em saída não rica (redirecionada, --no-color, scripts), os mesmos dados são renderizados como Markdown:

markdown

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

Códigos de saída

Código	Significado
`0`	A busca foi bem-sucedida (incluindo respostas sem resultados).
`1`	A chamada à API de busca da documentação hospedada falhou; stderr é impresso embutido.

Relacionado

Was this useful?