CLI commands

Documentação

`openclaw docs`

Pesquise o índice ativo da documentação do OpenClaw pelo terminal.

Uso

bash

openclaw docs                       # exibe o ponto de entrada da documentação e um exemplo de pesquisaopenclaw docs <query...>            # pesquisa o índice ativo da documentação

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

Sem uma consulta, openclaw docs exibe a URL do ponto de entrada da documentação e um comando de pesquisa de exemplo, em vez de executar uma pesquisa.

Exemplos

bash

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

Como funciona

openclaw docs chama https://docs.openclaw.ai/api/search e renderiza os resultados em JSON. A solicitação de pesquisa usa um tempo limite fixo de 30 segundos.

Saída

Em um terminal com formatação avançada (TTY), os resultados são renderizados como um título seguido por uma lista com marcadores: título da página, URL vinculada da documentação e um pequeno trecho na linha seguinte. Quando não há resultados, é exibido "Nenhum resultado.".

Em uma saída sem formatação avançada (redirecionada por pipe, --no-color, scripts), os mesmos dados são renderizados como Markdown:

markdown

# Pesquisa na documentação: <query> - [Título](https://docs.openclaw.ai/...) - trecho- [Título](https://docs.openclaw.ai/...) - trecho

Códigos de saída

Código	Significado
`0`	A pesquisa foi concluída com sucesso, incluindo respostas sem resultados.
`1`	A chamada à API hospedada de pesquisa da documentação falhou; stderr exibe a mensagem de erro.

Relacionado

Was this useful?