> ## Documentation Index > Fetch the complete documentation index at: https://docs.olostep.com/llms.txt > Use this file to discover all available pages before exploring further. # Utilisation de l’Olostep CLI > Structure des commandes, sortie, JSON, options globales, variables d’environnement et codes de sortie. ## Structure des commandes ```bash theme={null} olostep [arguments] [flags] ``` Les commandes sont regroupées par ce sur quoi elles agissent, par exemple `olostep keys list` ou `olostep monitors pause `. Les principales commandes de données web ont un raccourci qui exécute leur commande de création : | Raccourci | Exécute | | - | - | | `olostep scrape ` | `olostep scrape create ` | | `olostep search ""` | `olostep search create ""` | | `olostep map ` | `olostep map create ` | | `olostep crawl ` | `olostep crawl create ` | | `olostep answer ""` | `olostep answer create ""` | | `olostep extract ` | `olostep extract run ` | `olostep whoami` est équivalent à `olostep account info`. ## Obtenir de l’aide ```bash theme={null} olostep --help # chaque groupe de commandes olostep monitors --help # les commandes dans un groupe olostep monitors create --help # les arguments et options d'une commande olostep help export logs # trouver des commandes par ce qu'elles font ``` `olostep help ` liste les commandes dont le nom ou la description contient chaque mot. L’aide fonctionne sans connexion. ## Sortie Le CLI choisit sa sortie en fonction de sa destination : | Destination de la sortie | Ce que vous obtenez | | - | - | | Un terminal | Markdown formaté : titres, tableaux et couleurs. Le rouge est utilisé uniquement pour les erreurs. | | Un tuyau ou un fichier, ou si `NO_COLOR` est défini | Le même Markdown en texte brut, sans couleurs. | | Toute destination, avec `--json` | JSON exact, pour scripts et agents. | Les erreurs vont vers stderr, donc le piping de stdout ne les mélange jamais dans vos données. Les couleurs sont également désactivées lorsque `FORCE_COLOR=0` ou `TERM=dumb` est défini : ```bash theme={null} NO_COLOR=1 olostep credits balance ``` ### JSON Ajoutez `--json` à toute commande qui le liste dans son aide : ```bash theme={null} olostep scrape https://example.com -f markdown --json ``` Les commandes qui appellent Olostep renvoient un objet JSON : ```json theme={null} { "operation": "", "mode": "executed", "data": {}, "warnings": [] } ``` | Champ | Description | | - | - | | `operation` | L’opération exécutée. | | `mode` | L’un de `read`, `executed`, `dry_run`, `browser` ou `unavailable`. | | `data` | Le résultat. Sa structure dépend de la commande. | | `warnings` | Tout ce que vous devez savoir sur le résultat, comme des données partielles. Vide lorsqu'il n'y a rien. | Analysez le JSON, pas la sortie lisible par l’homme. La sortie humaine peut changer entre les versions. ### Sélectionner des champs `--fields` ne conserve que les champs que vous nommez. Séparez les champs par des virgules, et atteignez les champs imbriqués avec un point. Chaque champ que vous choisissez est imprimé sous le chemin que vous avez donné : ```bash theme={null} olostep whoami --json --fields mode,warnings ``` ```json theme={null} {"mode":"read","warnings":[]} ``` Pour choisir des champs imbriqués, regardez la sortie complète `--json` une fois, puis nommez-les comme `data.`. `--fields` fonctionne également sans `--json`, et affiche uniquement ces champs dans le tableau. ### Pipeliner dans jq ```bash theme={null} olostep credits balance --json | jq '.data' olostep crawl pages --json | jq '.data' ``` ## Passer des valeurs | Type d'option | Comment la passer | Exemple | | - | - | - | | Texte ou nombre | Après l'option | `--country US`, `--max-pages 50` | | Liste répétable | Répétez l'option, ou séparez par des virgules | `-f markdown -f html` ou `-f markdown,html` | | JSON | JSON en ligne, ou `@` et un chemin de fichier | `--metadata '{"project":"q3"}'` ou `--items @urls.json` | | Booléen | L'option seule | `--include-subdomain` | | Choix fixe | Une des valeurs montrées dans l'aide | `--days 7`, `--format csv` | Les URLs et requêtes positionnelles peuvent également être passées en tant qu'options, par exemple `olostep scrape create --url-to-scrape https://example.com` ou `olostep search create --query "olostep"`. ## Commandes qui modifient des choses Les commandes qui créent, modifient ou suppriment quelque chose, ou utilisent des crédits, le précisent dans leur aide. Elles prennent en charge : | Option | Ce qu'elle fait | | - | - | | `--dry-run` | Montre l'appel que le CLI ferait, et n'envoie rien. | | `--preview` | Demande à Olostep de prévisualiser le changement sans le faire. | | `--yes` | Passe la confirmation. Les commandes qui peuvent supprimer ou écraser nécessitent `--yes` lorsqu'il n'y a pas de terminal pour confirmer. Sans cela, elles se terminent avec le code `4`. | ```bash theme={null} olostep monitors delete --dry-run olostep monitors delete --yes ``` Les commandes qui utilisent des crédits, comme `scrape`, `search`, `map`, `crawl`, `answer`, `extract`, `batch create`, `monitors create`, `monitors run` et `agents run`, indiquent `This consumes credits` ou `consumes credits` dans leur aide. ## Options globales Ces options fonctionnent sur chaque commande : | Option | Description | | - | - | | `-h`, `--help` | Affiche l'aide pour la commande et quitte. | | `--server ` | Le serveur Olostep CLI à utiliser. Par défaut `https://cli.olostep.com/mcp`. | | `--token ` | Utilise ce jeton au lieu de la connexion enregistrée. Voir [Authentification](https://docs.olostep.com/cli/authentication.md#scripts-ci-and-agents). | | `--refresh-tools` | Récupère la liste actuelle des commandes et de leurs entrées depuis le serveur au lieu de la copie en cache. | Ces options fonctionnent sur chaque commande qui les affiche dans son aide : | Option | Description | | - | - | | `--json` | Affiche du JSON : pour scripts et agents. | | `--fields ` | Uniquement ces champs, séparés par des virgules (`a.b` pour les champs imbriqués). | | `--dry-run` | Montre l'appel qu'il ferait, et n'envoie rien. | | `--preview` | Prévisualise sans rien changer. | | `--yes` | Ne demande pas d'abord (nécessaire sans terminal). | ## Variables d’environnement | Variable | Description | | - | - | | `OLOSTEP_TOKEN` | Un jeton à utiliser au lieu de la connexion enregistrée. Identique à `--token`. | | `OLOSTEP_SERVER` | L'URL du serveur. Identique à `--server`. | | `OLOSTEP_HOME` | Où le script d'installation place le CLI. Par défaut `~/.olostep`. Doit être un chemin absolu. | | `NO_COLOR` | Toute valeur désactive les couleurs. | | `XDG_CONFIG_HOME` | Le CLI conserve sa connexion dans `$XDG_CONFIG_HOME/olostep`. Par défaut `~/.config/olostep`. | | `CI` | Désactive l'avis de mise à jour. | ## Codes de sortie | Code | Signification | | - | - | | `0` | Terminé. | | `1` | La commande a échoué. Le message est sur stderr. | | `2` | Commande ou arguments incorrects. | | `3` | Connexion nécessaire. Exécutez `olostep login` ou définissez `OLOSTEP_TOKEN`. | | `4` | La commande nécessite `--yes`. | | `5` | Le serveur n'a pas pu être atteint. | This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.