File size: 25,797 Bytes
0dbc9de | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 | ---
title: CLI
description: Options et commandes de la CLI OpenCode.
---
import { Tabs, TabItem } from "@astrojs/starlight/components"
La CLI OpenCode démarre par défaut le [TUI](/docs/tui) lorsqu'il est exécuté sans aucun argument.
```bash
opencode
```
Mais elle accepte également les commandes documentées sur cette page. Cela vous permet d'interagir avec OpenCode par programme.
```bash
opencode run "Explain how closures work in JavaScript"
```
---
### tui
Démarrez l’interface utilisateur du terminal OpenCode.
```bash
opencode [project]
```
#### Options
| Option | Court | Description |
| ---------------------------------------- | ----- | ----------------------------------------------------------------------------- |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Continuer la dernière session |
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID de session pour continuer |
| <nobr><code>{"--fork"}</code></nobr> | | Forker la session en continuant (à utiliser avec `--continue` ou `--session`) |
| <nobr><code>{"--prompt"}</code></nobr> | | Prompt à utiliser |
| <nobr><code>{"--model"}</code></nobr> | `-m` | Modèle à utiliser sous forme de fournisseur/modèle |
| <nobr><code>{"--agent"}</code></nobr> | | Agent à utiliser |
| <nobr><code>{"--port"}</code></nobr> | | Port d'écoute |
| <nobr><code>{"--hostname"}</code></nobr> | | Nom d'hôte d'écoute |
---
## Commandes
La CLI OpenCode dispose également des commandes suivantes.
---
### agent
Gérer les agents pour OpenCode.
```bash
opencode agent [command]
```
---
### attach
Attachez un terminal à un serveur backend OpenCode déjà en cours d'exécution démarré via les commandes `serve` ou `web`.
```bash
opencode attach [url]
```
Cela permet d'utiliser le TUI avec un backend OpenCode distant. Par exemple :
```bash
# Start the backend server for web/mobile access
opencode web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
opencode attach http://10.20.30.40:4096
```
#### Options
| Option | Court | Description |
| ---------------------------------------- | ----- | -------------------------------------------------------------------------------------------------- |
| <nobr><code>{"--dir"}</code></nobr> | | Répertoire de travail dans lequel démarrer TUI |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Continuer la dernière session |
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID de session pour continuer |
| <nobr><code>{"--fork"}</code></nobr> | | Dupliquer la session lors de la reprise (à utiliser avec `--continue` ou `--session`) |
| <nobr><code>{"--password"}</code></nobr> | `-p` | Mot de passe d'authentification de base (par défaut `OPENCODE_SERVER_PASSWORD`) |
| <nobr><code>{"--username"}</code></nobr> | `-u` | Nom d'utilisateur d'authentification de base (par défaut `OPENCODE_SERVER_USERNAME` ou `opencode`) |
---
#### create
Créez un nouvel agent avec une configuration personnalisée.
```bash
opencode agent create
```
Cette commande vous guidera dans la création d'un nouvel agent avec un prompt système personnalisé et une configuration d'outils.
---
#### list
Liste tous les agents disponibles.
```bash
opencode agent list
```
---
### auth
Commande pour gérer les informations d’identification et la connexion des fournisseurs.
```bash
opencode auth [command]
```
---
#### login
OpenCode est alimenté par la liste des fournisseurs sur [Models.dev](https://models.dev), vous pouvez donc utiliser `opencode auth login` pour configurer les clés API pour tout fournisseur que vous souhaitez utiliser. Ceci est stocké dans `~/.local/share/opencode/auth.json`.
```bash
opencode auth login
```
Lorsque OpenCode démarre, il charge les fournisseurs à partir du fichier d'informations d'identification, ainsi que les clés définies dans vos environnements ou un fichier `.env` dans votre projet.
---
#### list
Liste tous les fournisseurs authentifiés tels qu'ils sont stockés dans le fichier d'informations d'identification.
```bash
opencode auth list
```
Ou la version courte.
```bash
opencode auth ls
```
---
#### logout
Vous déconnecte d'un fournisseur en l'effaçant du fichier d'informations d'identification.
```bash
opencode auth logout
```
---
### github
Gérez l'agent GitHub pour l'automatisation du dépôt.
```bash
opencode github [command]
```
---
#### install
Installez l'agent GitHub dans votre dépôt.
```bash
opencode github install
```
Cela configure le flux de travail GitHub Actions nécessaire et vous guide tout au long du processus de configuration. [En savoir plus](/docs/github).
---
#### run
Exécutez l'agent GitHub. Ceci est généralement utilisé dans les GitHub Actions.
```bash
opencode github run
```
##### Options
| Option | Description |
| ------------------------------------- | ---------------------------------------------------- |
| <nobr><code>{"--event"}</code></nobr> | Événement simulé GitHub pour lequel exécuter l'agent |
| <nobr><code>{"--token"}</code></nobr> | Jeton d'accès personnel GitHub |
---
### MCP
Gérer les serveurs Model Context Protocol.
```bash
opencode mcp [command]
```
---
#### add
Ajoutez un serveur MCP à votre configuration.
```bash
opencode mcp add
```
Cette commande vous guidera dans l’ajout d’un serveur MCP local ou distant.
---
#### list
Liste tous les serveurs MCP configurés et leur état de connexion.
```bash
opencode mcp list
```
Ou utilisez la version courte.
```bash
opencode mcp ls
```
---
#### auth
Authentifiez-vous auprès d'un serveur MCP compatible OAuth.
```bash
opencode mcp auth [name]
```
Si vous ne fournissez pas de nom de serveur, vous serez invité à sélectionner parmi les serveurs compatibles OAuth disponibles.
Vous pouvez également répertorier les serveurs compatibles OAuth et leur statut d'authentification.
```bash
opencode mcp auth list
```
Ou utilisez la version courte.
```bash
opencode mcp auth ls
```
---
#### logout
Supprimez les informations d'identification OAuth pour un serveur MCP.
```bash
opencode mcp logout [name]
```
---
#### debug
Déboguer les problèmes de connexion OAuth pour un serveur MCP.
```bash
opencode mcp debug <name>
```
---
### models
Liste tous les modèles disponibles auprès des fournisseurs configurés.
```bash
opencode models [provider]
```
Cette commande affiche tous les modèles disponibles parmi vos fournisseurs configurés au format `provider/model`.
Ceci est utile pour déterminer le nom exact du modèle à utiliser dans [votre config](/docs/config/).
Vous pouvez éventuellement transmettre un ID de fournisseur pour filtrer les modèles en fonction de ce fournisseur.
```bash
opencode models anthropic
```
#### Options
| Option | Description |
| --------------------------------------- | ------------------------------------------------------------------------------------------ |
| <nobr><code>{"--refresh"}</code></nobr> | Actualisez le cache des modèles à partir de models.dev |
| <nobr><code>{"--verbose"}</code></nobr> | Utiliser une sortie de modèle plus détaillée (inclut des métadonnées telles que les coûts) |
Utilisez l'option `--refresh` pour mettre à jour la liste des modèles mis en cache. Ceci est utile lorsque de nouveaux modèles ont été ajoutés à un fournisseur et que vous souhaitez les voir dans OpenCode.
```bash
opencode models --refresh
```
---
### run
Exécutez opencode en mode non interactif en transmettant directement un prompt.
```bash
opencode run [message..]
```
Ceci est utile pour les scripts, l'automatisation ou lorsque vous souhaitez une réponse rapide sans lancer le TUI complet. Par exemple :
```bash "opencode run"
opencode run Explain the use of context in Go
```
Vous pouvez également vous connecter à une instance `opencode serve` en cours d'exécution pour éviter les temps de démarrage à froid du serveur MCP à chaque exécution :
```bash
# Start a headless server in one terminal
opencode serve
# In another terminal, run commands that attach to it
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
```
#### Options
| Option | Court | Description |
| ---------------------------------------- | ----- | -------------------------------------------------------------------------------------------------- |
| <nobr><code>{"--command"}</code></nobr> | | La commande à exécuter, utilisez le message pour les arguments |
| <nobr><code>{"--continue"}</code></nobr> | `-c` | Continuer la dernière session |
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID de session pour continuer |
| <nobr><code>{"--fork"}</code></nobr> | | Forker la session en continuant (à utiliser avec `--continue` ou `--session`) |
| <nobr><code>{"--share"}</code></nobr> | | Partager la session |
| <nobr><code>{"--model"}</code></nobr> | `-m` | Modèle à utiliser sous forme de fournisseur/modèle |
| <nobr><code>{"--agent"}</code></nobr> | | Agent à utiliser |
| <nobr><code>{"--file"}</code></nobr> | `-f` | Fichier(s) à joindre au message |
| <nobr><code>{"--format"}</code></nobr> | | Format : par défaut (formaté) ou json (événements JSON bruts) |
| <nobr><code>{"--title"}</code></nobr> | | Titre de la session (utilise un prompt tronqué si aucune valeur n'est fournie) |
| <nobr><code>{"--attach"}</code></nobr> | | Connectez-vous à un serveur opencode en cours d'exécution (par exemple, http://localhost:4096) |
| <nobr><code>{"--password"}</code></nobr> | `-p` | Mot de passe d'authentification de base (par défaut `OPENCODE_SERVER_PASSWORD`) |
| <nobr><code>{"--username"}</code></nobr> | `-u` | Nom d'utilisateur d'authentification de base (par défaut `OPENCODE_SERVER_USERNAME` ou `opencode`) |
| <nobr><code>{"--dir"}</code></nobr> | | Répertoire d'exécution, ou chemin sur le serveur distant lors de l'attachement |
| <nobr><code>{"--variant"}</code></nobr> | | Variante du modèle (effort de raisonnement spécifique au fournisseur) |
| <nobr><code>{"--thinking"}</code></nobr> | | Afficher les blocs de réflexion |
| <nobr><code>{"--port"}</code></nobr> | | Port du serveur local (port aléatoire par défaut) |
---
### serve
Démarrez un serveur OpenCode sans interface graphique pour un accès API. Consultez le [serveur docs](/docs/server) pour l'interface complète HTTP.
```bash
opencode serve
```
Cela démarre un serveur HTTP qui fournit un accès API aux fonctionnalités d'OpenCode sans l'interface TUI. Définissez `OPENCODE_SERVER_PASSWORD` pour activer l'authentification de base HTTP (le nom d'utilisateur par défaut est `opencode`).
#### Options
| Option | Description |
| ---------------------------------------- | ---------------------------------------------------------- |
| <nobr><code>{"--port"}</code></nobr> | Port d'écoute |
| <nobr><code>{"--hostname"}</code></nobr> | Nom d'hôte d'écoute |
| <nobr><code>{"--mdns"}</code></nobr> | Activer la découverte mDNS |
| <nobr><code>{"--cors"}</code></nobr> | Origines de navigateur supplémentaires pour autoriser CORS |
---
### session
Gérer les sessions OpenCode.
```bash
opencode session [command]
```
---
#### list
Liste toutes les sessions OpenCode.
```bash
opencode session list
```
##### Options
| Option | Court | Description |
| ----------------------------------------- | ----- | -------------------------------------------- |
| <nobr><code>{"--max-count"}</code></nobr> | `-n` | Limiter aux N sessions les plus récentes |
| <nobr><code>{"--format"}</code></nobr> | | Format de sortie : tableau ou json (tableau) |
---
### stats
Affichez les statistiques d'utilisation et de coût des jetons pour vos sessions OpenCode.
```bash
opencode stats
```
#### Options
| Option | Description |
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| <nobr><code>{"--days"}</code></nobr> | Afficher les statistiques des N derniers jours (depuis le début) |
| <nobr><code>{"--tools"}</code></nobr> | Nombre d'outils à afficher (tous) |
| <nobr><code>{"--models"}</code></nobr> | Afficher la répartition de l'utilisation du modèle (masqué par défaut). Passez un numéro pour afficher les N premiers |
| <nobr><code>{"--project"}</code></nobr> | Filtrer par projet (tous les projets, chaîne vide : projet actuel) |
---
### export
Exportez les données de session au format JSON.
```bash
opencode export [sessionID]
```
Si vous ne fournissez pas d'ID de session, vous serez invité à sélectionner parmi les sessions disponibles.
---
### import
Importez les données de session à partir d'un fichier JSON ou d'une URL de partage OpenCode.
```bash
opencode import <file>
```
Vous pouvez importer à partir d'un fichier local ou d'une URL de partage OpenCode.
```bash
opencode import session.json
opencode import https://opncd.ai/s/abc123
```
---
### web
Démarrez un serveur OpenCode sans interface graphique avec une interface Web.
```bash
opencode web
```
Cela démarre un serveur HTTP et ouvre un navigateur Web pour accéder à OpenCode via une interface Web. Définissez `OPENCODE_SERVER_PASSWORD` pour activer l'authentification de base HTTP (le nom d'utilisateur par défaut est `opencode`).
#### Options
| Option | Description |
| ---------------------------------------- | ---------------------------------------------------------- |
| <nobr><code>{"--port"}</code></nobr> | Port d'écoute |
| <nobr><code>{"--hostname"}</code></nobr> | Nom d'hôte d'écoute |
| <nobr><code>{"--mdns"}</code></nobr> | Activer la découverte mDNS |
| <nobr><code>{"--cors"}</code></nobr> | Origines de navigateur supplémentaires pour autoriser CORS |
---
### acp
Démarrez un serveur ACP (Agent Client Protocol).
```bash
opencode acp
```
Cette commande démarre un serveur ACP qui communique via stdin/stdout en utilisant nd-JSON.
#### Options
| Option | Description |
| ---------------------------------------- | --------------------- |
| <nobr><code>{"--cwd"}</code></nobr> | Répertoire de travail |
| <nobr><code>{"--port"}</code></nobr> | Port d'écoute |
| <nobr><code>{"--hostname"}</code></nobr> | Nom d'hôte d'écoute |
---
### uninstall
Désinstallez OpenCode et supprimez tous les fichiers associés.
```bash
opencode uninstall
```
#### Options
| Option | Court | Description |
| ------------------------------------------- | ----- | --------------------------------------------------- |
| <nobr><code>{"--keep-config"}</code></nobr> | `-c` | Conserver les fichiers de configuration |
| <nobr><code>{"--keep-data"}</code></nobr> | `-d` | Conserver les données de session et les instantanés |
| <nobr><code>{"--dry-run"}</code></nobr> | | Afficher ce qui serait supprimé sans supprimer |
| <nobr><code>{"--force"}</code></nobr> | `-f` | Ignorer les invites de confirmation |
---
### upgrade
Met à jour opencode vers la dernière version ou une version spécifique.
```bash
opencode upgrade [target]
```
Pour mettre à niveau vers la dernière version.
```bash
opencode upgrade
```
Pour passer à une version spécifique.
```bash
opencode upgrade v0.1.48
```
#### Options
| Option | Court | Description |
| -------------------------------------- | ----- | --------------------------------------------------------------- |
| <nobr><code>{"--method"}</code></nobr> | `-m` | La méthode d'installation utilisée ; curl, npm, pnpm, bun, brew |
---
## Options globales
La CLI opencode prend les flags globaux suivants.
| Option | Court | Description |
| ------------------------------------------ | ----- | ---------------------------------------- |
| <nobr><code>{"--help"}</code></nobr> | `-h` | Afficher l'aide |
| <nobr><code>{"--version"}</code></nobr> | `-v` | Afficher le numéro de version |
| <nobr><code>{"--print-logs"}</code></nobr> | | Afficher les logs sur stderr |
| <nobr><code>{"--log-level"}</code></nobr> | | Niveau de log (DEBUG, INFO, WARN, ERROR) |
---
## Variables d'environnement
OpenCode peut être configuré à l'aide de variables d'environnement.
| Variables | Type | Description |
| ------------------------------------- | ------- | --------------------------------------------------------------------------------- |
| `OPENCODE_AUTO_SHARE` | booléen | Partager automatiquement des sessions |
| `OPENCODE_GIT_BASH_PATH` | chaîne | Chemin vers l'exécutable Git Bash sur Windows |
| `OPENCODE_CONFIG` | chaîne | Chemin d'accès au fichier de configuration |
| `OPENCODE_TUI_CONFIG` | chaîne | Chemin d'accès au fichier de configuration TUI |
| `OPENCODE_CONFIG_DIR` | chaîne | Chemin d'accès au répertoire de configuration |
| `OPENCODE_CONFIG_CONTENT` | chaîne | Contenu de configuration JSON en ligne |
| `OPENCODE_DISABLE_AUTOUPDATE` | booléen | Désactiver les vérifications automatiques des mises à jour |
| `OPENCODE_DISABLE_PRUNE` | booléen | Désactiver le nettoyage des anciennes données |
| `OPENCODE_DISABLE_TERMINAL_TITLE` | booléen | Désactiver les mises à jour automatiques des titres du terminal |
| `OPENCODE_PERMISSION` | chaîne | Configuration des autorisations JSON intégrées |
| `OPENCODE_DISABLE_DEFAULT_PLUGINS` | booléen | Désactiver les plugins par défaut |
| `OPENCODE_DISABLE_LSP_DOWNLOAD` | booléen | Désactiver les téléchargements automatiques du serveur LSP |
| `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | booléen | Activer les modèles expérimentaux |
| `OPENCODE_DISABLE_AUTOCOMPACT` | booléen | Désactiver le compactage automatique du contexte |
| `OPENCODE_DISABLE_CLAUDE_CODE` | booléen | Désactiver la lecture de `.claude` (prompt + compétences) |
| `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | booléen | Désactiver la lecture `~/.claude/CLAUDE.md` |
| `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | booléen | Désactiver le chargement de `.claude/skills` |
| `OPENCODE_DISABLE_MODELS_FETCH` | booléen | Désactiver la récupération de modèles à partir de sources distantes |
| `OPENCODE_FAKE_VCS` | chaîne | Faux fournisseur VCS à des fins de test |
| `OPENCODE_CLIENT` | chaîne | Identifiant du client (par défaut `cli`) |
| `OPENCODE_ENABLE_EXA` | booléen | Activer les outils de recherche Web Exa |
| `OPENCODE_SERVER_PASSWORD` | chaîne | Activer l'authentification de base pour `serve`/`web` |
| `OPENCODE_SERVER_USERNAME` | chaîne | Remplacer le nom d'utilisateur d'authentification de base (par défaut `opencode`) |
| `OPENCODE_MODELS_URL` | chaîne | URL personnalisé pour récupérer la configuration des modèles |
---
### Expérimental
Ces variables d'environnement activent des fonctionnalités expérimentales qui peuvent être modifiées ou supprimées.
| Variables | Type | Description |
| ----------------------------------------------- | ------- | --------------------------------------------------------------- |
| `OPENCODE_EXPERIMENTAL` | booléen | Activer les fonctionnalités expérimentales du drapeau global |
| `OPENCODE_EXPERIMENTAL_ICON_DISCOVERY` | booléen | Activer la découverte d'icônes |
| `OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT` | booléen | Désactiver la copie lors de la sélection dans TUI |
| `OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS` | numéro | Délai d'expiration par défaut pour les commandes bash en ms |
| `OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX` | numéro | Nombre maximum de jetons de sortie pour les réponses LLM |
| `OPENCODE_EXPERIMENTAL_FILEWATCHER` | booléen | Activer l'observateur de fichiers pour l'ensemble du répertoire |
| `OPENCODE_EXPERIMENTAL_OXFMT` | booléen | Activer le formateur oxfmt |
| `OPENCODE_EXPERIMENTAL_LSP_TOOL` | booléen | Activer l'outil expérimental LSP |
| `OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHER` | booléen | Désactiver l'observateur de fichiers |
| `OPENCODE_EXPERIMENTAL_EXA` | booléen | Activer les fonctionnalités Exa expérimentales |
| `OPENCODE_EXPERIMENTAL_LSP_TY` | booléen | Activer TY LSP pour les fichiers python |
| `OPENCODE_EXPERIMENTAL_PLAN_MODE` | booléen | Activer le mode plan |
| `OPENCODE_EXPERIMENTAL_BACKGROUND_SUBAGENTS` | booléen | Activer les tâches de sous-agents en arrière-plan |
| `OPENCODE_EXPERIMENTAL_EVENT_SYSTEM` | booléen | Activer le système d'événements expérimental |
| `OPENCODE_EXPERIMENTAL_NATIVE_LLM` | booléen | Activer le chemin de requête LLM natif |
| `OPENCODE_EXPERIMENTAL_PARALLEL` | booléen | Activer l'exécution parallèle de la recherche web |
| `OPENCODE_EXPERIMENTAL_SCOUT` | booléen | Activer le sous-agent Scout |
| `OPENCODE_EXPERIMENTAL_WORKSPACES` | booléen | Activer la prise en charge des espaces de travail |
|