Aller au contenu

CLI

Options et commandes de la CLI OpenCode.

La CLI OpenCode demarre par defaut la TUI lorsqu’elle est executee sans arguments.

Fenêtre de terminal
opencode

Mais elle accepte egalement des commandes comme documente sur cette page. Cela vous permet d’interagir avec OpenCode par programmation.

Fenêtre de terminal
opencode run "Explain how closures work in JavaScript"

tui

Demarrer l’interface terminal utilisateur OpenCode.

Fenêtre de terminal
opencode [project]

Indicateurs

IndicateurCourtDescription
--continue-cContinuer la derniere session
--session-sID de session a continuer
--promptPrompt a utiliser
--model-mModele a utiliser sous la forme fournisseur/modele
--agentAgent a utiliser
--portPort d’ecoute
--hostnameNom d’hote d’ecoute

Commandes

La CLI OpenCode a egalement les commandes suivantes.


agent

Gerer les agents pour OpenCode.

Fenêtre de terminal
opencode agent [command]

attach

Attacher un terminal a un serveur principal OpenCode deja demarre via les commandes serve ou web.

Fenêtre de terminal
opencode attach [url]

Cela permet d’utiliser la TUI avec un serveur principal OpenCode distant. Par exemple :

Fenêtre de terminal
# Demarrer le serveur principal pour l'acces web/mobile
opencode web --port 4096 --hostname 0.0.0.0
# Dans un autre terminal, attacher la TUI au serveur principal en cours d'execution
opencode attach http://10.20.30.40:4096

Indicateurs

IndicateurCourtDescription
--dirRepertoire de travail pour demarrer la TUI
--session-sID de session a continuer

create

Creer un nouvel agent avec une configuration personnalisee.

Fenêtre de terminal
opencode agent create

Cette 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.

Fenêtre de terminal
opencode agent list

auth

Commande pour gerer les informations d’identification et la connexion pour les fournisseurs.

Fenêtre de terminal
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.

Fenêtre de terminal
opencode auth login

Lorsqu’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.

Fenêtre de terminal
opencode auth list

Ou la version courte.

Fenêtre de terminal
opencode auth ls

logout

Vous deconnecter d’un fournisseur en le supprimant du fichier d’informations d’identification.

Fenêtre de terminal
opencode auth logout

github

Gerer l’agent GitHub pour l’automatisation de depot.

Fenêtre de terminal
opencode github [command]

install

Installer l’agent GitHub dans votre depot.

Fenêtre de terminal
opencode github install

Cela 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.

Fenêtre de terminal
opencode github run
Indicateurs
IndicateurDescription
--eventEvenement GitHub fictif pour executer l’agent
--tokenJeton d’acces personnel GitHub

mcp

Gerer les serveurs Model Context Protocol.

Fenêtre de terminal
opencode mcp [command]

add

Ajouter un serveur MCP a votre configuration.

Fenêtre de terminal
opencode mcp add

Cette 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.

Fenêtre de terminal
opencode mcp list

Ou utilisez la version courte.

Fenêtre de terminal
opencode mcp ls

auth

S’authentifier aupres d’un serveur MCP compatible OAuth.

Fenêtre de terminal
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.

Fenêtre de terminal
opencode mcp auth list

Ou utilisez la version courte.

Fenêtre de terminal
opencode mcp auth ls

logout

Supprimer les informations d’identification OAuth pour un serveur MCP.

Fenêtre de terminal
opencode mcp logout [name]

debug

Deboguer les problemes de connexion OAuth pour un serveur MCP.

Fenêtre de terminal
opencode mcp debug <name>

models

Lister tous les modeles disponibles des fournisseurs configures.

Fenêtre de terminal
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.

Fenêtre de terminal
opencode models anthropic

Indicateurs

IndicateurDescription
--refreshActualiser le cache des modeles depuis models.dev
--verboseUtiliser 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.

Fenêtre de terminal
opencode models --refresh

run

Executer opencode en mode non-interactif en passant directement un prompt.

Fenêtre de terminal
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 :

Fenêtre de terminal
opencode run Explain the use of context in Go

Vous 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 :

Fenêtre de terminal
# Demarrer un serveur sans interface dans un terminal
opencode serve
# Dans un autre terminal, executer des commandes qui s'y attachent
opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"

Indicateurs

IndicateurCourtDescription
--commandLa commande a executer, utiliser le message pour les arguments
--continue-cContinuer la derniere session
--session-sID de session a continuer
--sharePartager la session
--model-mModele a utiliser sous la forme fournisseur/modele
--agentAgent a utiliser
--file-fFichier(s) a attacher au message
--formatFormat: default (formate) ou json (evenements JSON bruts)
--titleTitre pour la session (utilise le prompt tronque si aucune valeur)
--attachS’attacher a un serveur opencode en cours d’execution (ex: http://localhost:4096)
--portPort 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.

Fenêtre de terminal
opencode serve

Cela demarre un serveur HTTP qui fournit un acces API aux fonctionnalites d’opencode sans l’interface TUI.

Indicateurs

IndicateurDescription
--portPort d’ecoute
--hostnameNom d’hote d’ecoute
--mdnsActiver la decouverte mDNS
--corsOrigines de navigateur supplementaires pour autoriser CORS

session

Gerer les sessions OpenCode.

Fenêtre de terminal
opencode session [command]

list

Lister toutes les sessions OpenCode.

Fenêtre de terminal
opencode session list
Indicateurs
IndicateurCourtDescription
--max-count-nLimiter aux N sessions les plus recentes
--formatFormat de sortie: table ou json (table)

stats

Afficher les statistiques d’utilisation de jetons et de couts pour vos sessions OpenCode.

Fenêtre de terminal
opencode stats

Indicateurs

IndicateurDescription
--daysAfficher les statistiques pour les derniers N jours (tout le temps)
--toolsNombre d’outils a afficher (tous)
--modelsAfficher la ventilation de l’utilisation des modeles (cache par defaut). Passer un nombre pour afficher les top N
--projectFiltrer par projet (tous les projets, chaine vide: projet actuel)

export

Exporter les donnees de session au format JSON.

Fenêtre de terminal
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.

Fenêtre de terminal
opencode import <file>

Vous pouvez importer depuis un fichier local ou une URL de partage OpenCode.

Fenêtre de terminal
opencode import session.json
opencode import https://opncd.ai/s/abc123

web

Demarrer un serveur OpenCode sans interface avec une interface web.

Fenêtre de terminal
opencode web

Cela demarre un serveur HTTP et ouvre un navigateur web pour acceder a OpenCode via une interface web.

Indicateurs

IndicateurDescription
--portPort d’ecoute
--hostnameNom d’hote d’ecoute
--mdnsActiver la decouverte mDNS
--corsOrigines de navigateur supplementaires pour autoriser CORS

acp

Demarrer un serveur ACP (Agent Client Protocol).

Fenêtre de terminal
opencode acp

Cette commande demarre un serveur ACP qui communique via stdin/stdout en utilisant nd-JSON.

Indicateurs

IndicateurDescription
--cwdRepertoire de travail
--portPort d’ecoute
--hostnameNom d’hote d’ecoute

uninstall

Desinstaller OpenCode et supprimer tous les fichiers associes.

Fenêtre de terminal
opencode uninstall

Indicateurs

IndicateurCourtDescription
--keep-config-cConserver les fichiers de configuration
--keep-data-dConserver les donnees de session et les snapshots
--dry-runAfficher ce qui serait supprime sans supprimer
--force-fIgnorer les invites de confirmation

upgrade

Mettre a jour opencode vers la derniere version ou une version specifique.

Fenêtre de terminal
opencode upgrade [target]

Pour mettre a niveau vers la derniere version.

Fenêtre de terminal
opencode upgrade

Pour mettre a niveau vers une version specifique.

Fenêtre de terminal
opencode upgrade v0.1.48

Indicateurs

IndicateurCourtDescription
--method-mLa methode d’installation qui a ete utilisee; curl, npm, pnpm, bun, brew

Indicateurs globaux

La CLI opencode accepte les indicateurs globaux suivants.

IndicateurCourtDescription
--help-hAfficher l’aide
--version-vAfficher le numero de version
--print-logsImprimer les logs sur stderr
--log-levelNiveau de log (DEBUG, INFO, WARN, ERROR)

Variables d’environnement

OpenCode peut etre configure en utilisant des variables d’environnement.

VariableTypeDescription
OPENCODE_AUTO_SHAREbooleenPartager automatiquement les sessions
OPENCODE_GIT_BASH_PATHchaineChemin vers l’executable Git Bash sur Windows
OPENCODE_CONFIGchaineChemin vers le fichier de configuration
OPENCODE_CONFIG_DIRchaineChemin vers le repertoire de configuration
OPENCODE_CONFIG_CONTENTchaineContenu de configuration json en ligne
OPENCODE_DISABLE_AUTOUPDATEbooleenDesactiver les verifications de mise a jour automatiques
OPENCODE_DISABLE_PRUNEbooleenDesactiver le nettoyage des anciennes donnees
OPENCODE_DISABLE_TERMINAL_TITLEbooleenDesactiver les mises a jour automatiques du titre du terminal
OPENCODE_PERMISSIONchaineConfiguration des permissions json en ligne
OPENCODE_DISABLE_DEFAULT_PLUGINSbooleenDesactiver les plugins par defaut
OPENCODE_DISABLE_LSP_DOWNLOADbooleenDesactiver les telechargements automatiques de serveurs LSP
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooleenActiver les modeles experimentaux
OPENCODE_DISABLE_AUTOCOMPACTbooleenDesactiver la compression automatique du contexte
OPENCODE_DISABLE_CLAUDE_CODEbooleenDesactiver la lecture de .claude (prompt + competences)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTbooleenDesactiver la lecture de ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSbooleenDesactiver le chargement de .claude/skills
OPENCODE_CLIENTchaineIdentifiant de client (par defaut cli)
OPENCODE_ENABLE_EXAbooleenActiver les outils de recherche web Exa

Experimental

Ces variables d’environnement activent des fonctionnalites experimentales qui peuvent changer ou etre supprimees.

VariableTypeDescription
OPENCODE_EXPERIMENTALbooleenActiver toutes les fonctionnalites experimentales
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooleenActiver la decouverte d’icones
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleenDesactiver la copie sur selection dans la TUI
OPENCODE_EXPERIMENTAL_BASH_MAX_OUTPUT_LENGTHnombreLongueur maximale de sortie pour les commandes bash
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnombreDelai d’attente par defaut pour les commandes bash en ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnombreJetons de sortie max pour les reponses LLM
OPENCODE_EXPERIMENTAL_FILEWATCHERbooleenActiver l’observateur de fichiers pour tout le repertoire
OPENCODE_EXPERIMENTAL_OXFMTbooleenActiver le formateur oxfmt
OPENCODE_EXPERIMENTAL_LSP_TOOLbooleenActiver l’outil LSP experimental