CLI commands

Documentación

`openclaw docs`

Busca en el índice en línea de la documentación de OpenClaw desde la terminal.

Uso

bash

openclaw docs                       # muestra el punto de entrada de la documentación y un ejemplo de búsquedaopenclaw docs <query...>            # busca en el índice en línea de la documentación

Argumento	Descripción
`[query...]`	Consulta de búsqueda de formato libre. Las consultas de varias palabras se unen con espacios y se envían como una.

Sin una consulta, openclaw docs muestra la URL del punto de entrada de la documentación y un comando de búsqueda de ejemplo en lugar de ejecutar una búsqueda.

Ejemplos

bash

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

Cómo funciona

openclaw docs llama a https://docs.openclaw.ai/api/search y representa los resultados JSON. La solicitud de búsqueda utiliza un tiempo de espera fijo de 30 segundos.

Salida

En una terminal enriquecida (TTY), los resultados se muestran como un encabezado seguido de una lista con viñetas: el título de la página, la URL enlazada de la documentación y un breve fragmento en la línea siguiente. Si no hay resultados, se muestra "Sin resultados.".

En una salida no enriquecida (redirigida mediante una canalización, --no-color, scripts), los mismos datos se representan como Markdown:

markdown

# Búsqueda en la documentación: <query> - [Título](https://docs.openclaw.ai/...) - fragmento- [Título](https://docs.openclaw.ai/...) - fragmento

Códigos de salida

Código	Significado
`0`	La búsqueda se realizó correctamente, incluidas las respuestas sin resultados.
`1`	La llamada a la API alojada de búsqueda de documentación falló; stderr muestra el mensaje de error.

Contenido relacionado

Was this useful?