Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

openclaw docs

Recherchez dans l’index de documentation OpenClaw en direct depuis le terminal. La commande lance un shell vers le point de terminaison public de recherche MCP de la documentation hébergée par Mintlify à l’adresse https://docs.openclaw.ai/mcp.SearchOpenClaw 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 :
ArgumentDescription
[query...]Requête de recherche en texte libre. Les requêtes de plusieurs mots sont jointes avec 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’un exemple de commande de recherche au lieu de lancer une recherche.

Fonctionnement

openclaw docs invoque la CLI mcporter pour appeler l’outil MCP de recherche de la documentation, puis analyse les blocs Title: / Link: / Content: de la sortie de l’outil en une liste de résultats. Pour résoudre mcporter, OpenClaw vérifie dans l’ordre :
  1. mcporter dans PATH (utilisé directement s’il est présent).
  2. pnpm dlx mcporter ... si pnpm est installé.
  3. npx -y mcporter ... si npx est installé.
Si aucun n’est disponible, la commande échoue avec une indication pour installer pnpm (npm install -g pnpm). L’appel de recherche utilise un délai d’expiration 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 s’affichent sous forme d’en-tête suivi d’une liste à puces. Chaque puce affiche le titre de la page, l’URL liée de la documentation, et un court extrait à la ligne suivante. Les résultats vides affichent « Aucun résultat. ». Dans une sortie non riche (redirigée, --no-color, scripts), les mêmes données s’affichent en Markdown :
# Docs search: <query>

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

Codes de sortie

CodeSignification
0La recherche a réussi (y compris les réponses sans résultat).
1L’appel de l’outil MCP a échoué ; stderr est affiché en ligne.

Associé