Aller au contenu

CLI

Options et commandes CLI OpenCode.

La CLI OpenCode démarre par défaut le TUI lorsqu’il est exécuté sans aucun argument.

Fenêtre de terminal
opencode

Mais il accepte également les commandes documentées sur cette page. Cela vous permet d’interagir avec OpenCode par programme.

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

tui

Démarrez l’interface utilisateur du terminal OpenCode.

Fenêtre de terminal
opencode [project]

Drapeaux

DrapeauCourtDescriptif
--continue-cContinuer la dernière séance
--session-sID de session pour continuer
--forkForker la session en continuant (à utiliser avec --continue ou --session)
--promptInvite à utiliser
--model-mModèle à utiliser sous forme de fournisseur/modèle
--agentAgent à utiliser
--portPort à écouter sur
--hostnameNom d’hôte sur lequel écouter

Commandes

La CLI OpenCode dispose également des commandes suivantes.


agent

Gérer les agents pour OpenCode.

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

Fenêtre de terminal
opencode attach [url]

Cela permet d’utiliser le TUI avec un backend OpenCode distant. Par exemple:

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

Drapeaux

DrapeauCourtDescriptif
--dirRépertoire de travail dans lequel démarrer TUI
--session-sID de session pour continuer

create

Créez un nouvel agent avec une configuration personnalisée.

Fenêtre de terminal
opencode agent create

Cette commande vous guidera dans la création d’un nouvel agent avec une invite système personnalisée et une configuration d’outil.


list

Répertoriez tous les agents disponibles.

Fenêtre de terminal
opencode agent list

auth

Commande pour gérer les informations d’identification et la connexion des fournisseurs.

Fenêtre de terminal
opencode auth [command]

login

OpenCode est alimenté par la liste des fournisseurs sur 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.

Fenêtre de terminal
opencode auth login

Lorsque OpenCode démarre, il charge les fournisseurs à partir du fichier d’informations d’identification. Et s’il y a des clés définies dans vos environnements ou un fichier .env dans votre projet.


list

Répertorie tous les fournisseurs authentifiés tels qu’ils sont stockés 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 déconnecte d’un fournisseur en l’effaçant du fichier d’informations d’identification.

Fenêtre de terminal
opencode auth logout

github

Gérez l’agent GitHub pour l’automatisation du référentiel.

Fenêtre de terminal
opencode github [command]

install

Installez l’agent GitHub dans votre référentiel.

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


run

Exécutez l’agent GitHub. Ceci est généralement utilisé dans les GitHub Actions.

Fenêtre de terminal
opencode github run
Drapeaux
DrapeauDescriptif
--eventÉvénement simulé GitHub pour lequel exécuter l’agent
--tokenJeton d’accès personnel GitHub

MCP

Gérer les serveurs Model Context Protocol.

Fenêtre de terminal
opencode mcp [command]

add

Ajoutez un serveur MCP à votre configuration.

Fenêtre de terminal
opencode mcp add

Cette commande vous guidera dans l’ajout d’un serveur MCP local ou distant.


list

Répertoriez tous les serveurs MCP configurés et leur état de connexion.

Fenêtre de terminal
opencode mcp list

Ou utilisez la version courte.

Fenêtre de terminal
opencode mcp ls

auth

Authentifiez-vous auprès 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 invité à sélectionner parmi les serveurs compatibles OAuth disponibles.

Vous pouvez également répertorier 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

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

Fenêtre de terminal
opencode mcp logout [name]

debug

Déboguer les problèmes de connexion OAuth pour un serveur MCP.

Fenêtre de terminal
opencode mcp debug <name>

models

Répertoriez tous les modèles disponibles auprès des fournisseurs configurés.

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

Vous pouvez éventuellement transmettre un ID de fournisseur pour filtrer les modèles en fonction de ce fournisseur.

Fenêtre de terminal
opencode models anthropic

Drapeaux

DrapeauDescriptif
--refreshActualisez le cache des modèles à partir de models.dev
--verboseUtiliser une sortie de modèle plus détaillée (inclut des métadonnées telles que les coûts)

Utilisez l’indicateur --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.

Fenêtre de terminal
opencode models --refresh

run

Exécutez opencode en mode non interactif en transmettant directement une invite.

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

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

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

Drapeaux

DrapeauCourtDescriptif
--commandLa commande à exécuter, utilisez message pour args
--continue-cContinuer la dernière séance
--session-sID de session pour continuer
--forkForker la session en continuant (à utiliser avec --continue ou --session)
--sharePartager la séance
--model-mModèle à utiliser sous forme de fournisseur/modèle
--agentAgent à utiliser
--file-fFichier(s) à joindre au message
--formatFormat : par défaut (formaté) ou json (événements JSON bruts)
--titleTitre de la session (utilise une invite tronquée si aucune valeur n’est fournie)
--attachConnectez-vous à un serveur opencode en cours d’exécution (par exemple, http://localhost:4096)
--portPort du serveur local (port aléatoire par défaut)

serve

Démarrez un serveur OpenCode sans tête pour un accès API. Consultez le serveur docs pour l’interface complète HTTP.

Fenêtre de terminal
opencode serve

Cela démarre un serveur HTTP qui fournit à API un accès à la fonctionnalité 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).

Drapeaux

DrapeauDescriptif
--portPort à écouter sur
--hostnameNom d’hôte sur lequel écouter
--mdnsActiver la découverte mDNS
--corsOrigines de navigateur supplémentaires pour autoriser CORS

session

Gérer les sessions OpenCode.

Fenêtre de terminal
opencode session [command]

list

Répertoriez toutes les sessions OpenCode.

Fenêtre de terminal
opencode session list
Drapeaux
DrapeauCourtDescriptif
--max-count-nLimiter aux N sessions les plus récentes
--formatFormat de sortie : tableau ou json (tableau)

stats

Affichez les statistiques d’utilisation et de coût des jetons pour vos sessions OpenCode.

Fenêtre de terminal
opencode stats

Drapeaux

DrapeauDescriptif
--daysAfficher les statistiques des N derniers jours (tous les temps)
--toolsNombre d’outils à afficher (tous)
--modelsAfficher la répartition de l’utilisation du modèle (masqué par défaut). Passez un numéro pour afficher le premier N
--projectFiltrer par projet (tous les projets, chaîne vide : projet en cours)

export

Exportez les données de session sous JSON.

Fenêtre de terminal
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’un partage OpenCode URL.

Fenêtre de terminal
opencode import <file>

Vous pouvez importer à partir d’un fichier local ou d’un partage OpenCode URL.

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

web

Démarrez un serveur OpenCode sans tête avec une interface Web.

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

Drapeaux

DrapeauDescriptif
--portPort à écouter sur
--hostnameNom d’hôte sur lequel écouter
--mdnsActiver la découverte mDNS
--corsOrigines de navigateur supplémentaires pour autoriser CORS

acp

Démarrez un serveur ACP (Agent Client Protocol).

Fenêtre de terminal
opencode acp

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

Drapeaux

DrapeauDescriptif
--cwdRépertoire de travail
--portPort à écouter sur
--hostnameNom d’hôte sur lequel écouter

uninstall

Désinstallez OpenCode et supprimez tous les fichiers associés.

Fenêtre de terminal
opencode uninstall

Drapeaux

DrapeauCourtDescriptif
--keep-config-cConserver les fichiers de configuration
--keep-data-dConserver les données de session et les instantanés
--dry-runAfficher ce qui serait supprimé sans supprimer
--force-fIgnorer les invites de confirmation

upgrade

Met à jour opencode vers la dernière version ou une version spécifique.

Fenêtre de terminal
opencode upgrade [target]

Pour mettre à niveau vers la dernière version.

Fenêtre de terminal
opencode upgrade

Pour passer à une version spécifique.

Fenêtre de terminal
opencode upgrade v0.1.48

Drapeaux

DrapeauCourtDescriptif
--method-mLa méthode d’installation utilisée ; curl, npm, pnpm, bun, brew

Drapeaux globaux

La CLI opencode prend les indicateurs globaux suivants.

DrapeauCourtDescriptif
--help-hAfficher l’aide
--version-vImprimer le numéro de version
--print-logsImprimer les journaux sur stderr
--log-levelNiveau de journalisation (DEBUG, INFO, WARN, ERROR)

Variables d’environnement

OpenCode peut être configuré à l’aide de variables d’environnement.

VariablesTypeDescriptif
OPENCODE_AUTO_SHAREbooléenPartager automatiquement des sessions
OPENCODE_GIT_BASH_PATHchaîneChemin vers l’exécutable Git Bash sur Windows
OPENCODE_CONFIGchaîneChemin d’accès au fichier de configuration
OPENCODE_CONFIG_DIRchaîneChemin d’accès au répertoire de configuration
OPENCODE_CONFIG_CONTENTchaîneContenu de configuration JSON en ligne
OPENCODE_DISABLE_AUTOUPDATEbooléenDésactiver les vérifications automatiques des mises à jour
OPENCODE_DISABLE_PRUNEbooléenDésactiver l’élagage des anciennes données
OPENCODE_DISABLE_TERMINAL_TITLEbooléenDésactiver les mises à jour automatiques des titres du terminal
OPENCODE_PERMISSIONchaîneConfiguration des autorisations JSON intégrées
OPENCODE_DISABLE_DEFAULT_PLUGINSbooléenDésactiver les plugins par défaut
OPENCODE_DISABLE_LSP_DOWNLOADbooléenDésactiver les téléchargements automatiques du serveur LSP
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooléenActiver les modèles expérimentaux
OPENCODE_DISABLE_AUTOCOMPACTbooléenDésactiver le compactage automatique du contexte
OPENCODE_DISABLE_CLAUDE_CODEbooléenDésactiver la lecture de .claude (invite + compétences)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTbooléenDésactiver la lecture ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSbooléenDésactiver le chargement de .claude/skills
OPENCODE_DISABLE_MODELS_FETCHbooléenDésactiver la récupération de modèles à partir de sources distantes
OPENCODE_FAKE_VCSchaîneFaux fournisseur VCS à des fins de test
OPENCODE_DISABLE_FILETIME_CHECKbooléenDésactiver la vérification de l’heure des fichiers pour l’optimisation
OPENCODE_CLIENTchaîneIdentifiant du client (par défaut cli)
OPENCODE_ENABLE_EXAbooléenActiver les outils de recherche Web Exa
OPENCODE_SERVER_PASSWORDchaîneActiver l’authentification de base pour serve/web
OPENCODE_SERVER_USERNAMEchaîneRemplacer le nom d’utilisateur d’authentification de base (par défaut opencode)
OPENCODE_MODELS_URLchaîneURL 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.

VariablesTypeDescriptif
OPENCODE_EXPERIMENTALbooléenActiver toutes les fonctionnalités expérimentales
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooléenActiver la découverte d’icônes
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooléenDésactiver la copie lors de la sélection dans TUI
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnuméroDélai d’expiration par défaut pour les commandes bash dans ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnuméroNombre maximum de jetons de sortie pour les réponses LLM
OPENCODE_EXPERIMENTAL_FILEWATCHERbooléenActiver l’observateur de fichiers pour l’ensemble du répertoire
OPENCODE_EXPERIMENTAL_OXFMTbooléenActiver le formateur oxfmt
OPENCODE_EXPERIMENTAL_LSP_TOOLbooléenActiver l’outil expérimental LSP
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooléenDésactiver l’observateur de fichiers
OPENCODE_EXPERIMENTAL_EXAbooléenActiver les fonctionnalités Exa expérimentales
OPENCODE_EXPERIMENTAL_LSP_TYbooléenActiver la vérification expérimentale du type LSP
OPENCODE_EXPERIMENTAL_MARKDOWNbooléenActiver les fonctionnalités Markdown expérimentales
OPENCODE_EXPERIMENTAL_PLAN_MODEbooléenActiver le mode plan