Docs

`openclaw docs`

Recherchez l’index de la documentation en direct d’OpenClaw depuis le terminal. La commande appelle le point de terminaison de recherche MCP de la documentation hébergée publiquement par Mintlify à l’adresse OpenClawhttps://docs.openclaw.ai/mcp.search_open_claw et affiche les résultats dans votre terminal.

Utilisation

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

Arguments :

Argument	Description
`[query...]`	Recherche de forme libre. Les requêtes à plusieurs mots sont jointes par des espaces et envoyées comme une seule requête.

Exemples

openclaw docs browser existing-session
openclaw docs sandbox allowHostControl
openclaw docs gateway token secretref

Sans requête, openclaw docs affiche l’URL du point d’entrée de la documentation ainsi qu’une commande de recherche exemple au lieu d’effectuer une recherche.

Fonctionnement

openclaw docs invoque la CLI mcporterCLI pour appeler l’outil MCP de recherche de documentation, puis analyse les blocs Title: / Link: / Content: de la sortie de l’outil pour obtenir une liste de résultats.

Pour résoudre mcporterOpenClaw, OpenClaw vérifie dans l’ordre :

mcporter sur PATH (utilisé directement si présent).
pnpm dlx mcporter ... si pnpm est installé.
npx -y mcporter ... si npx est installé.

Si aucun n’est disponible, la commande échoue avec une suggestion d’installer pnpm (npm install -g pnpm).

L’appel de recherche utilise un délai d’attente fixe de 30 secondes. Les extraits de résultats sont tronqués à environ 220 caractères par entrée.

Sortie

Dans un terminal riche (TTY), les résultats sont affichés sous forme d’un titre suivi d’une liste à puces. Chaque puce affiche le titre de la page, l’URL de la documentation liée et un court extrait sur la ligne suivante. Les résultats vides affichent « Aucun résultat ».

En sortie non riche (redirigée via un tube, --no-color, scripts), les mêmes données sont rendues au format Markdown :

# Docs search: <query>

- [Title](https://docs.openclaw.ai/...) - snippet
- [Title](https://docs.openclaw.ai/...) - snippet

Codes de sortie

Code	Signification
`0`	Recherche réussie (y compris les réponses sans résultat).
`1`	L’appel à l’outil MCP a échoué ; stderr est affiché en ligne.