Utilisation de la CLI d'OpenCode

OpenCode fournit une interface en ligne de commande (CLI) puissante. Il peut non seulement lancer l'interface TUI interactive, mais aussi effectuer des opérations automatisées et scriptées via des commandes.

Par défaut, OpenCode CLI lance l'interface TUI, mais sa véritable puissance réside dans l'invocation programmable.

OpenCode CLI n'est pas seulement un outil de commande ; c'est une interface de développement IA programmable.

OpenCode CLI peut être abstrait en trois couches :

  • Couche d'interaction:tui / web / attach
  • Couche d'exécution:run / agent / mcp / github
  • Couche de service:serve / acp

👉 En essence, c'estAgent IA + environnement de développement local + CLI programmable + API Serverun point d'entrée unifié.

Voici le tableau complet des commandes OpenCode CLI :

Comportement de base

Commande/Utilisation Description Remarques
opencode Démarrer l'interface TUI par défaut Lorsqu'aucun paramètre n'est fourni
opencode run "msg" Exécuter des tâches en mode non interactif Automatisation/Scripts

Paramètres de démarrage de la TUI

Option Short Description
--continue -c Continuer la session précédente
--session -s Spécifier l'ID de session
--fork — Dupliquer la session
--prompt — Invite initiale
--model -m Spécifier le modèle
--agent — Spécifier l'agent
--port — Port d'écoute
--hostname — Adresse de l'hôte

Commandes CLI principales

Commande Description Sous-commandes clés
agent Gérer les agents create / list
auth Gérer l'authentification login / list / logout
attach Se connecter à un backend distant —
github Automatisation GitHub install / run
mcp Gestion des services MCP add / list / auth / debug
models Afficher la liste des modèles —
run Exécution non interactive —
serve Démarrer le service API —
web Service d'interface Web —
session Gestion des sessions liste
stats Statistiques de jetons/coûts —
export Exporter les sessions —
import Importer les sessions —
acp Démarrer le service du protocole ACP —
uninstall Désinstaller —
upgrade Mettre à niveau la version —

Paramètres de la commande run

Option Short Description
--continue -c Continuer la session
--session -s Spécifier la session
--fork — Fork
--share — Partager la session
--model -m Spécifier le modèle
--agent — Spécifier l'agent
--file -f Joindre des fichiers
--format — Format de sortie (json)
--title — Titre de la session
--attach — Se connecter à un service existant
--port — Port local

Paramètres de commande du service

serve / web / acp

Option Description
--port Port d'écoute
--hostname Adresse de l'hôte
--mdns Découverte du réseau local
--cors Autoriser cross-origin

Paramètres de session / stats
Commande Option Description
session --max-count (-n) N entrées récentes
session --format table/json
stats --days N derniers jours
stats --tools Statistiques des outils
stats --models Utilisation des modèles
stats --project Filtre de projet

Options globales

Option Short Description
--help -h Aide
--version -v Version
--print-logs — Journal de sortie
--log-level — Niveau de journalisation

Variables d'environnement

Variable Type Objectif
OPENCODE_AUTO_SHARE booléen Partage automatique
OPENCODE_CONFIG string Chemin de configuration
OPENCODE_TUI_CONFIG string Configuration TUI
OPENCODE_DISABLE_AUTOUPDATE booléen Désactiver les mises à jour
OPENCODE_SERVER_PASSWORD string Authentification API
OPENCODE_MODELS_URL string Source du modèle

Fonctionnalités expérimentales

Variable Type Objectif
OPENCODE_EXPERIMENTAL booléen Activer toutes les fonctionnalités expérimentales
OPENCODE_EXPERIMENTAL_LSP_TOOL booléen Outils LSP
OPENCODE_EXPERIMENTAL_PLAN_MODE booléen Mode planification
OPENCODE_EXPERIMENTAL_FILEWATCHER booléen Surveillance de fichiers

I. Utilisation de base

1. Démarrer TUI (comportement par défaut)

opencode

Équivalent à entrer dans l’interface de terminal interactive

2. Spécifier le répertoire du projet

opencode /path/to/project

Démarrer la TUI dans le répertoire spécifié, par exemple, la démarrer dans le répertoire opencode-example-test :

opencode opencode-example-test

3. Mode non interactif (invocation de script)

opencode run 解释一下 JavaScript 中闭包的原理

Renvoie directement les résultats sans entrer dans l'interface.


II. Capacités principales de la CLI

Les capacités principales de la CLI OpenCode peuvent être résumées en trois catégories :

  • Mode interactif :TUI (par défaut)
  • Exécution de commandes :run / serve
  • Gestion du système :agent / auth / session, etc.

III. Paramètres courants (Flags)

Paramètre Short Description
--continue -c Continuer la session précédente
--session -s Spécifier l'ID de session
--fork Créer une bifurcation à partir de la session actuelle
--model -m Spécifier le modèle (provider/model)
--agent Spécifier l'agent
--port Port du service
--hostname Adresse d'écoute

IV. Détails des commandes principales

1. run (le plus couramment utilisé)

Utilisé pour l'exécution non interactive :

opencode run 分析这个 Go 项目的上下文使用方式

Scénarios d'application :

  • Automatisation de scripts
  • CI/CD
  • Questions-réponses rapides

Se connecter à un service en arrière-plan (éviter le démarrage à froid)

# 启动后台服务
opencode serve

# 使用 run 连接
opencode run --attach http://localhost:4096 解释 async/await

Paramètres communs

Paramètre Description
--model Spécifier le modèle
--file Joindre des fichiers
--format Format de sortie (json / default)
--share Partager la session

V. auth (gestion de l'authentification)

Connexion

opencode auth login

Configurer la clé API (stockée localement)


Afficher les fournisseurs connectés

opencode auth list

Déconnexion

opencode auth logout

VI. models (gestion des modèles)

Afficher tous les modèles

opencode models

Filtrer par fournisseur

opencode models anthropic

Actualiser la liste des modèles

opencode models --refresh

VII. agent (système d'agents)

Créer un agent

opencode agent create

Prompts personnalisables + outils

Voir les agents

opencode agent list

VIII. session (gestion des sessions)

Voir les sessions

opencode session list

Limiter le nombre

opencode session list -n 10

IX. serve (mode service)

Démarrer le service API :

opencode serve

Fournit une interface HTTP (sans interface utilisateur)

Paramètres optionnels :

  • --port : Port
  • --hostname : Adresse d'écoute

X. web (interface Web)

opencode web

Démarrer la version avec interface web


XI. mcp (capacité d'extension)

Ajouter un service MCP

opencode mcp add

Voir la liste

opencode mcp list

MCP est utilisé pour étendre les capacités de l'IA (par ex., appel d'outils)


XII. stats (statistiques d'utilisation)

opencode stats

Voir l'utilisation des jetons et les coûts


XIII. export / import

Exporter les sessions

opencode export

Importer les sessions

opencode import session.json

XIV. Mise à niveau et désinstallation

Upgrade

opencode upgrade

Désinstaller

opencode uninstall

XV. Paramètres globaux

Paramètre Description
--help Afficher l'aide
--version Voir la version
--log-level Niveau de journalisation

XVI. Variables d'environnement (configuration avancée)

OpenCode permet de contrôler le comportement via des variables d'environnement, par exemple :

OPENCODE_DISABLE_AUTOUPDATE=true
OPENCODE_SERVER_PASSWORD=123456

Utilisations courantes :

  • Désactiver les mises à jour automatiques
  • Configurer l'authentification du service
  • Chemin de configuration personnalisé

XVII. Suggestions d'utilisation (points clés)

  • Utiliser TUI pour le développement quotidien
  • Utiliser run pour l'automatisation
  • Combiner agent pour les tâches complexes
  • Utiliser serve + attach pour les appels à haute fréquence
Autres extensions