CLI
Options et commandes de la CLI OpenCode.
La CLI OpenCode demarre par defaut la TUI lorsqu’elle est executee sans arguments.
opencodeMais elle accepte egalement des commandes comme documente sur cette page. Cela vous permet d’interagir avec OpenCode par programmation.
opencode run "Explain how closures work in JavaScript"tui
Demarrer l’interface terminal utilisateur OpenCode.
opencode [project]Indicateurs
| Indicateur | Court | Description |
|---|---|---|
--continue | -c | Continuer la derniere session |
--session | -s | ID de session a continuer |
--prompt | Prompt a utiliser | |
--model | -m | Modele a utiliser sous la forme fournisseur/modele |
--agent | Agent a utiliser | |
--port | Port d’ecoute | |
--hostname | Nom d’hote d’ecoute |
Commandes
La CLI OpenCode a egalement les commandes suivantes.
agent
Gerer les agents pour OpenCode.
opencode agent [command]attach
Attacher un terminal a un serveur principal OpenCode deja demarre via les commandes serve ou web.
opencode attach [url]Cela permet d’utiliser la TUI avec un serveur principal OpenCode distant. Par exemple :
# Demarrer le serveur principal pour l'acces web/mobileopencode web --port 4096 --hostname 0.0.0.0
# Dans un autre terminal, attacher la TUI au serveur principal en cours d'executionopencode attach http://10.20.30.40:4096Indicateurs
| Indicateur | Court | Description |
|---|---|---|
--dir | Repertoire de travail pour demarrer la TUI | |
--session | -s | ID de session a continuer |
create
Creer un nouvel agent avec une configuration personnalisee.
opencode agent createCette commande vous guidera dans la creation d’un nouvel agent avec un prompt systeme et une configuration d’outils personnalises.
list
Lister tous les agents disponibles.
opencode agent listauth
Commande pour gerer les informations d’identification et la connexion pour les fournisseurs.
opencode auth [command]login
OpenCode est alimente par la liste des fournisseurs sur Models.dev, vous pouvez donc utiliser opencode auth login pour configurer des cles API pour tous les fournisseurs que vous souhaitez utiliser. Cela est stocke dans ~/.local/share/opencode/auth.json.
opencode auth loginLorsqu’OpenCode demarre, il charge les fournisseurs a partir du fichier d’informations d’identification. Et s’il y a des cles definies dans vos environnements ou un fichier .env dans votre projet.
list
Liste tous les fournisseurs authentifies tels que stockes dans le fichier d’informations d’identification.
opencode auth listOu la version courte.
opencode auth lslogout
Vous deconnecter d’un fournisseur en le supprimant du fichier d’informations d’identification.
opencode auth logoutgithub
Gerer l’agent GitHub pour l’automatisation de depot.
opencode github [command]install
Installer l’agent GitHub dans votre depot.
opencode github installCela configure le workflow GitHub Actions necessaire et vous guide dans le processus de configuration. En savoir plus.
run
Executer l’agent GitHub. Ceci est generalement utilise dans GitHub Actions.
opencode github runIndicateurs
| Indicateur | Description |
|---|---|
--event | Evenement GitHub fictif pour executer l’agent |
--token | Jeton d’acces personnel GitHub |
mcp
Gerer les serveurs Model Context Protocol.
opencode mcp [command]add
Ajouter un serveur MCP a votre configuration.
opencode mcp addCette commande vous guidera dans l’ajout d’un serveur MCP local ou distant.
list
Lister tous les serveurs MCP configures et leur statut de connexion.
opencode mcp listOu utilisez la version courte.
opencode mcp lsauth
S’authentifier aupres d’un serveur MCP compatible OAuth.
opencode mcp auth [name]Si vous ne fournissez pas de nom de serveur, vous serez invite a selectionner parmi les serveurs compatibles OAuth disponibles.
Vous pouvez egalement lister les serveurs compatibles OAuth et leur statut d’authentification.
opencode mcp auth listOu utilisez la version courte.
opencode mcp auth lslogout
Supprimer les informations d’identification OAuth pour un serveur MCP.
opencode mcp logout [name]debug
Deboguer les problemes de connexion OAuth pour un serveur MCP.
opencode mcp debug <name>models
Lister tous les modeles disponibles des fournisseurs configures.
opencode models [provider]Cette commande affiche tous les modeles disponibles dans vos fournisseurs configures au format fournisseur/modele.
Ceci est utile pour determiner le nom exact du modele a utiliser dans votre configuration.
Vous pouvez eventuellement passer un ID de fournisseur pour filtrer les modeles par ce fournisseur.
opencode models anthropicIndicateurs
| Indicateur | Description |
|---|---|
--refresh | Actualiser le cache des modeles depuis models.dev |
--verbose | Utiliser une sortie de modele plus verbeuse (inclut les metadonnees comme les couts) |
Utilisez l’indicateur --refresh pour mettre a jour la liste des modeles en cache. C’est utile lorsque de nouveaux modeles ont ete ajoutes a un fournisseur et que vous voulez les voir dans OpenCode.
opencode models --refreshrun
Executer opencode en mode non-interactif en passant directement un prompt.
opencode run [message..]Ceci est utile pour les scripts, l’automatisation, ou lorsque vous voulez une reponse rapide sans demarrer la TUI complete. Par exemple :
opencode run Explain the use of context in GoVous pouvez egalement vous attacher a une instance opencode serve en cours d’execution pour eviter les temps de demarrage a froid du serveur MCP a chaque execution :
# Demarrer un serveur sans interface dans un terminalopencode serve
# Dans un autre terminal, executer des commandes qui s'y attachentopencode run --attach http://localhost:4096 "Explain async/await in JavaScript"Indicateurs
| Indicateur | Court | Description |
|---|---|---|
--command | La commande a executer, utiliser le message pour les arguments | |
--continue | -c | Continuer la derniere session |
--session | -s | ID de session a continuer |
--share | Partager la session | |
--model | -m | Modele a utiliser sous la forme fournisseur/modele |
--agent | Agent a utiliser | |
--file | -f | Fichier(s) a attacher au message |
--format | Format: default (formate) ou json (evenements JSON bruts) | |
--title | Titre pour la session (utilise le prompt tronque si aucune valeur) | |
--attach | S’attacher a un serveur opencode en cours d’execution (ex: http://localhost:4096) | |
--port | Port pour le serveur local (par defaut: port aleatoire) |
serve
Demarrer un serveur OpenCode sans interface pour l’acces API. Consultez la documentation du serveur pour l’interface HTTP complete.
opencode serveCela demarre un serveur HTTP qui fournit un acces API aux fonctionnalites d’opencode sans l’interface TUI.
Indicateurs
| Indicateur | Description |
|---|---|
--port | Port d’ecoute |
--hostname | Nom d’hote d’ecoute |
--mdns | Activer la decouverte mDNS |
--cors | Origines de navigateur supplementaires pour autoriser CORS |
session
Gerer les sessions OpenCode.
opencode session [command]list
Lister toutes les sessions OpenCode.
opencode session listIndicateurs
| Indicateur | Court | Description |
|---|---|---|
--max-count | -n | Limiter aux N sessions les plus recentes |
--format | Format de sortie: table ou json (table) |
stats
Afficher les statistiques d’utilisation de jetons et de couts pour vos sessions OpenCode.
opencode statsIndicateurs
| Indicateur | Description |
|---|---|
--days | Afficher les statistiques pour les derniers N jours (tout le temps) |
--tools | Nombre d’outils a afficher (tous) |
--models | Afficher la ventilation de l’utilisation des modeles (cache par defaut). Passer un nombre pour afficher les top N |
--project | Filtrer par projet (tous les projets, chaine vide: projet actuel) |
export
Exporter les donnees de session au format JSON.
opencode export [sessionID]Si vous ne fournissez pas d’ID de session, vous serez invite a selectionner parmi les sessions disponibles.
import
Importer les donnees de session depuis un fichier JSON ou une URL de partage OpenCode.
opencode import <file>Vous pouvez importer depuis un fichier local ou une URL de partage OpenCode.
opencode import session.jsonopencode import https://opncd.ai/s/abc123web
Demarrer un serveur OpenCode sans interface avec une interface web.
opencode webCela demarre un serveur HTTP et ouvre un navigateur web pour acceder a OpenCode via une interface web.
Indicateurs
| Indicateur | Description |
|---|---|
--port | Port d’ecoute |
--hostname | Nom d’hote d’ecoute |
--mdns | Activer la decouverte mDNS |
--cors | Origines de navigateur supplementaires pour autoriser CORS |
acp
Demarrer un serveur ACP (Agent Client Protocol).
opencode acpCette commande demarre un serveur ACP qui communique via stdin/stdout en utilisant nd-JSON.
Indicateurs
| Indicateur | Description |
|---|---|
--cwd | Repertoire de travail |
--port | Port d’ecoute |
--hostname | Nom d’hote d’ecoute |
uninstall
Desinstaller OpenCode et supprimer tous les fichiers associes.
opencode uninstallIndicateurs
| Indicateur | Court | Description |
|---|---|---|
--keep-config | -c | Conserver les fichiers de configuration |
--keep-data | -d | Conserver les donnees de session et les snapshots |
--dry-run | Afficher ce qui serait supprime sans supprimer | |
--force | -f | Ignorer les invites de confirmation |
upgrade
Mettre a jour opencode vers la derniere version ou une version specifique.
opencode upgrade [target]Pour mettre a niveau vers la derniere version.
opencode upgradePour mettre a niveau vers une version specifique.
opencode upgrade v0.1.48Indicateurs
| Indicateur | Court | Description |
|---|---|---|
--method | -m | La methode d’installation qui a ete utilisee; curl, npm, pnpm, bun, brew |
Indicateurs globaux
La CLI opencode accepte les indicateurs globaux suivants.
| Indicateur | Court | Description |
|---|---|---|
--help | -h | Afficher l’aide |
--version | -v | Afficher le numero de version |
--print-logs | Imprimer les logs sur stderr | |
--log-level | Niveau de log (DEBUG, INFO, WARN, ERROR) |
Variables d’environnement
OpenCode peut etre configure en utilisant des variables d’environnement.
| Variable | Type | Description |
|---|---|---|
OPENCODE_AUTO_SHARE | booleen | Partager automatiquement les sessions |
OPENCODE_GIT_BASH_PATH | chaine | Chemin vers l’executable Git Bash sur Windows |
OPENCODE_CONFIG | chaine | Chemin vers le fichier de configuration |
OPENCODE_CONFIG_DIR | chaine | Chemin vers le repertoire de configuration |
OPENCODE_CONFIG_CONTENT | chaine | Contenu de configuration json en ligne |
OPENCODE_DISABLE_AUTOUPDATE | booleen | Desactiver les verifications de mise a jour automatiques |
OPENCODE_DISABLE_PRUNE | booleen | Desactiver le nettoyage des anciennes donnees |
OPENCODE_DISABLE_TERMINAL_TITLE | booleen | Desactiver les mises a jour automatiques du titre du terminal |
OPENCODE_PERMISSION | chaine | Configuration des permissions json en ligne |
OPENCODE_DISABLE_DEFAULT_PLUGINS | booleen | Desactiver les plugins par defaut |
OPENCODE_DISABLE_LSP_DOWNLOAD | booleen | Desactiver les telechargements automatiques de serveurs LSP |
OPENCODE_ENABLE_EXPERIMENTAL_MODELS | booleen | Activer les modeles experimentaux |
OPENCODE_DISABLE_AUTOCOMPACT | booleen | Desactiver la compression automatique du contexte |
OPENCODE_DISABLE_CLAUDE_CODE | booleen | Desactiver la lecture de .claude (prompt + competences) |
OPENCODE_DISABLE_CLAUDE_CODE_PROMPT | booleen | Desactiver la lecture de ~/.claude/CLAUDE.md |
OPENCODE_DISABLE_CLAUDE_CODE_SKILLS | booleen | Desactiver le chargement de .claude/skills |
OPENCODE_CLIENT | chaine | Identifiant de client (par defaut cli) |
OPENCODE_ENABLE_EXA | booleen | Activer les outils de recherche web Exa |
Experimental
Ces variables d’environnement activent des fonctionnalites experimentales qui peuvent changer ou etre supprimees.
| Variable | Type | Description |
|---|---|---|
OPENCODE_EXPERIMENTAL | booleen | Activer toutes les fonctionnalites experimentales |
OPENCODE_EXPERIMENTAL_ICON_DISCOVERY | booleen | Activer la decouverte d’icones |
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | booleen | Desactiver la copie sur selection dans la TUI |
OPENCODE_EXPERIMENTAL_BASH_MAX_OUTPUT_LENGTH | nombre | Longueur maximale de sortie pour les commandes bash |
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | nombre | Delai d’attente par defaut pour les commandes bash en ms |
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAX | nombre | Jetons de sortie max pour les reponses LLM |
OPENCODE_EXPERIMENTAL_FILEWATCHER | booleen | Activer l’observateur de fichiers pour tout le repertoire |
OPENCODE_EXPERIMENTAL_OXFMT | booleen | Activer le formateur oxfmt |
OPENCODE_EXPERIMENTAL_LSP_TOOL | booleen | Activer l’outil LSP experimental |