Saltearse al contenido

CLI

OpenCode CLI opciones y comandos.

El OpenCode CLI de forma predeterminada inicia el TUI cuando se ejecuta sin ningún argumento.

Ventana de terminal
opencode

Pero también acepta comandos como se documenta en esta página. Esto le permite interactuar con OpenCode mediante programación.

Ventana de terminal
opencode run "Explain how closures work in JavaScript"

tui

Inicie la interfaz de usuario del terminal OpenCode.

Ventana de terminal
opencode [project]

Flags

FlagShortDescription
--continue-cContinuar la última sesión
--session-sID de sesión para continuar
--forkBifurcar la sesión al continuar (usar con --continue o --session)
--promptAviso de uso
--model-mModelo a utilizar en forma de proveedor/modelo
--agentAgente a utilizar
--portPuerto para escuchar
--hostnameNombre de host para escuchar

Comandos

El OpenCode CLI también tiene los siguientes comandos.


agent

Administrar agentes para OpenCode.

Ventana de terminal
opencode agent [command]

attach

Conecte una terminal a un servidor backend OpenCode que ya se esté ejecutando y iniciado mediante los comandos serve o web.

Ventana de terminal
opencode attach [url]

Esto permite usar TUI con un backend remoto OpenCode. Por ejemplo:

Ventana 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

Flags

FlagShortDescription
--dirDirectorio de trabajo para iniciar TUI en
--session-sID de sesión para continuar

create

Cree un nuevo agente con configuración personalizada.

Ventana de terminal
opencode agent create

Este comando lo guiará en la creación de un nuevo agente con un mensaje del sistema personalizado y una configuración de herramientas.


list

Enumere todos los agentes disponibles.

Ventana de terminal
opencode agent list

auth

Comando para administrar credenciales e iniciar sesión para proveedores.

Ventana de terminal
opencode auth [command]

login

OpenCode funciona con la lista de proveedores en Models.dev, por lo que puede usar opencode auth login para configurar las claves API para cualquier proveedor que desee utilizar. Esto se almacena en ~/.local/share/opencode/auth.json.

Ventana de terminal
opencode auth login

Cuando se inicia OpenCode, carga los proveedores desde el archivo de credenciales. Y si hay claves definidas en sus entornos o un archivo .env en su proyecto.


list

Enumera todos los proveedores autenticados tal como están almacenados en el archivo de credenciales.

Ventana de terminal
opencode auth list

O la versión corta.

Ventana de terminal
opencode auth ls

logout

Cierra tu sesión de un proveedor eliminándolo del archivo de credenciales.

Ventana de terminal
opencode auth logout

github

Administre el agente GitHub para la automatización del repositorio.

Ventana de terminal
opencode github [command]

install

Instale el agente GitHub en su repositorio.

Ventana de terminal
opencode github install

Esto configura el flujo de trabajo de acciones GitHub necesario y lo guía a través del proceso de configuración. Más información.


run

Ejecute el agente GitHub. Esto se usa normalmente en acciones GitHub.

Ventana de terminal
opencode github run
Flags
FlagDescription
--eventGitHub evento simulado para ejecutar el agente
--tokenGitHub token de acceso personal

mcp

Administrar servidores de protocolo de contexto modelo.

Ventana de terminal
opencode mcp [command]

add

Agregue un servidor MCP a su configuración.

Ventana de terminal
opencode mcp add

Este comando lo guiará para agregar un servidor MCP local o remoto.


list

Enumere todos los servidores MCP configurados y su estado de conexión.

Ventana de terminal
opencode mcp list

O utilice la versión corta.

Ventana de terminal
opencode mcp ls

auth

Autentíquese con un servidor MCP habilitado para OAuth.

Ventana de terminal
opencode mcp auth [name]

Si no proporciona un nombre de servidor, se le pedirá que seleccione entre los servidores compatibles con OAuth disponibles.

También puede enumerar los servidores compatibles con OAuth y su estado de autenticación.

Ventana de terminal
opencode mcp auth list

O utilice la versión corta.

Ventana de terminal
opencode mcp auth ls

logout

Elimine las credenciales OAuth para un servidor MCP.

Ventana de terminal
opencode mcp logout [name]

debug

Depurar problemas de conexión OAuth para un servidor MCP.

Ventana de terminal
opencode mcp debug <name>

models

Enumere todos los modelos disponibles de los proveedores configurados.

Ventana de terminal
opencode models [provider]

Este comando muestra todos los modelos disponibles en sus proveedores configurados en el formato provider/model.

Esto es útil para determinar el nombre exacto del modelo que se usará en su configuración.

Opcionalmente, puede pasar un ID de proveedor para filtrar modelos por ese proveedor.

Ventana de terminal
opencode models anthropic

Flags

FlagDescription
--refreshActualizar la caché de modelos desde models.dev
--verboseUtilice una salida del modelo más detallada (incluye metadatos como costos)

Utilice el indicador --refresh para actualizar la lista de modelos almacenados en caché. Esto es útil cuando se han agregado nuevos modelos a un proveedor y desea verlos en OpenCode.

Ventana de terminal
opencode models --refresh

run

Ejecute opencode en modo no interactivo pasando un mensaje directamente.

Ventana de terminal
opencode run [message..]

Esto es útil para secuencias de comandos, automatización o cuando desea una respuesta rápida sin iniciar el TUI completo. Por ejemplo.

Ventana de terminal
opencode run Explain the use of context in Go

También puede conectarse a una instancia opencode serve en ejecución para evitar tiempos de arranque en frío del servidor MCP en cada ejecución:

Ventana 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"

Flags

FlagShortDescription
--commandEl comando a ejecutar, use mensaje para args
--continue-cContinuar la última sesión
--session-sID de sesión para continuar
--forkBifurcar la sesión al continuar (usar con --continue o --session)
--shareComparte la sesión
--model-mModelo a utilizar en forma de proveedor/modelo
--agentAgente a utilizar
--file-fArchivo(s) para adjuntar al mensaje
--formatFormato: predeterminado (formateado) o json (eventos JSON sin formato)
--titleTítulo de la sesión (utiliza un mensaje truncado si no se proporciona ningún valor)
--attachAdjuntar a un servidor opencode en ejecución (por ejemplo, http://localhost:4096)
--portPuerto para el servidor local (el puerto predeterminado es aleatorio)

serve

Inicie un servidor OpenCode sin cabeza para acceso API. Consulte los documentos del servidor para conocer la interfaz HTTP completa.

Ventana de terminal
opencode serve

Esto inicia un servidor HTTP que proporciona acceso API a la funcionalidad opencode sin la interfaz TUI. Configure OPENCODE_SERVER_PASSWORD para habilitar la autenticación básica HTTP (el nombre de usuario predeterminado es opencode).

Banderas

BanderaDescripción
--portPuerto para escuchar
--hostnameNombre de host para escuchar
--mdnsHabilitar el descubrimiento de mDNS
--corsOrígenes de navegador adicionales para permitir CORS

session

Administrar OpenCode sesiones.

Ventana de terminal
opencode session [command]

list

Enumere todas las sesiones OpenCode.

Ventana de terminal
opencode session list
Flags
FlagShortDescription
--max-count-nLimitar a N sesiones más recientes
--formatFormato de salida: tabla o json (tabla)

stats

Muestre el uso de tokens y las estadísticas de costos para sus sesiones OpenCode.

Ventana de terminal
opencode stats

Flags

FlagDescription
--daysMostrar estadísticas de los últimos N días (todo el tiempo)
--toolsNúmero de herramientas para mostrar (todas)
--modelsMostrar el desglose del uso del modelo (oculto de forma predeterminada). Pase un número para mostrar la parte superior N
--projectFiltrar por proyecto (todos los proyectos, cadena vacía: proyecto actual)

export

Exportar datos de la sesión como JSON.

Ventana de terminal
opencode export [sessionID]

Si no proporciona una ID de sesión, se le pedirá que seleccione entre las sesiones disponibles.


import

Importe datos de sesión desde un archivo JSON o una URL compartida OpenCode.

Ventana de terminal
opencode import <file>

Puede importar desde un archivo local o una URL compartida OpenCode.

Ventana de terminal
opencode import session.json
opencode import https://opncd.ai/s/abc123

web

Inicie un servidor OpenCode sin cabeza con una interfaz web.

Ventana de terminal
opencode web

Esto inicia un servidor HTTP y abre un navegador web para acceder a OpenCode a través de una interfaz web. Configure OPENCODE_SERVER_PASSWORD para habilitar la autenticación básica HTTP (el nombre de usuario predeterminado es opencode).

Banderas

BanderaDescripción
--portPuerto para escuchar
--hostnameNombre de host para escuchar
--mdnsHabilitar el descubrimiento de mDNS
--corsOrígenes de navegador adicionales para permitir CORS

acp

Inicie un servidor ACP (Agent Client Protocol).

Ventana de terminal
opencode acp

Este comando inicia un servidor ACP que se comunica a través de stdin/stdout usando nd-JSON.

Flags

FlagDescription
--cwdDirectorio de trabajo
--portPuerto para escuchar
--hostnameNombre de host para escuchar

uninstall

Desinstale OpenCode y elimine todos los archivos relacionados.

Ventana de terminal
opencode uninstall

Flags

FlagShortDescription
--keep-config-cMantener archivos de configuración
--keep-data-dConservar datos de sesión e instantáneas
--dry-runMostrar lo que se eliminaría sin eliminar
--force-fSaltar mensajes de confirmación

upgrade

Actualiza opencode a la última versión o a una versión específica.

Ventana de terminal
opencode upgrade [target]

Para actualizar a la última versión.

Ventana de terminal
opencode upgrade

Para actualizar a una versión específica.

Ventana de terminal
opencode upgrade v0.1.48

Banderas

BanderaCortoDescripción
--method-mEl método de instalación que se utilizó; curl, npm, pnpm, bun, brew

Global Flags

El opencode CLI toma las siguientes banderas globales.

BanderaCortoDescripción
--help-hMostrar ayuda
--version-vNúmero de versión de impresión
--print-logsImprimir registros en stderr
--log-levelNivel de registro (DEBUG, INFO, WARN, ERROR)

Variables de entorno

OpenCode se puede configurar mediante variables de entorno.

VariableTypeDescription
OPENCODE_AUTO_SHAREbooleanoCompartir sesiones automáticamente
OPENCODE_GIT_BASH_PATHcadenaRuta al ejecutable de Git Bash en Windows
OPENCODE_CONFIGcadenaRuta al archivo de configuración
OPENCODE_CONFIG_DIRcadenaRuta al directorio de configuración
OPENCODE_CONFIG_CONTENTcadenaContenido de configuración json en línea
OPENCODE_DISABLE_AUTOUPDATEbooleanoDeshabilitar las comprobaciones automáticas de actualizaciones
OPENCODE_DISABLE_PRUNEbooleanoDeshabilitar la poda de datos antiguos
OPENCODE_DISABLE_TERMINAL_TITLEbooleanoDeshabilitar las actualizaciones automáticas de títulos de terminal
OPENCODE_PERMISSIONcadenaConfiguración de permisos json incorporados
OPENCODE_DISABLE_DEFAULT_PLUGINSbooleanoDeshabilitar complementos predeterminados
OPENCODE_DISABLE_LSP_DOWNLOADbooleanoDeshabilitar las descargas automáticas del servidor LSP
OPENCODE_ENABLE_EXPERIMENTAL_MODELSbooleanoHabilitar modelos experimentales
OPENCODE_DISABLE_AUTOCOMPACTbooleanoDeshabilitar la compactación automática de contexto
OPENCODE_DISABLE_CLAUDE_CODEbooleanoDeshabilitar la lectura desde .claude (mensaje + habilidades)
OPENCODE_DISABLE_CLAUDE_CODE_PROMPTbooleanoDesactivar lectura ~/.claude/CLAUDE.md
OPENCODE_DISABLE_CLAUDE_CODE_SKILLSbooleanoDeshabilitar la carga .claude/skills
OPENCODE_DISABLE_MODELS_FETCHbooleanoDeshabilitar la recuperación de modelos desde fuentes remotas
OPENCODE_FAKE_VCScadenaProveedor de VCS falso para fines de prueba
OPENCODE_DISABLE_FILETIME_CHECKbooleanoDeshabilite la verificación del tiempo del archivo para optimizarlo
OPENCODE_CLIENTcadenaIdentificador de cliente (por defecto cli)
OPENCODE_ENABLE_EXAbooleanoHabilitar las herramientas de búsqueda web de Exa
OPENCODE_SERVER_PASSWORDcadenaHabilite la autenticación básica para serve/web
OPENCODE_SERVER_USERNAMEcadenaAnular el nombre de usuario de autenticación básica (predeterminado opencode)
OPENCODE_MODELS_URLcadenaURL personalizada para buscar la configuración de modelos

Experimental

Estas variables de entorno habilitan funciones experimentales que pueden cambiar o eliminarse.

VariableTypeDescription
OPENCODE_EXPERIMENTALbooleanoHabilitar todas las funciones experimentales
OPENCODE_EXPERIMENTAL_ICON_DISCOVERYbooleanoHabilitar descubrimiento de íconos
OPENCODE_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanoDeshabilitar copia al seleccionar en TUI
OPENCODE_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnúmeroTiempo de espera predeterminado para comandos bash en ms
OPENCODE_EXPERIMENTAL_OUTPUT_TOKEN_MAXnúmeroTokens de salida máximos para respuestas LLM
OPENCODE_EXPERIMENTAL_FILEWATCHERbooleanoHabilite el observador de archivos para todo el directorio
OPENCODE_EXPERIMENTAL_OXFMTbooleanoHabilitar el formateador oxfmt
OPENCODE_EXPERIMENTAL_LSP_TOOLbooleanoHabilitar herramienta experimental LSP
OPENCODE_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanoDeshabilitar el observador de archivos
OPENCODE_EXPERIMENTAL_EXAbooleanoHabilitar funciones experimentales de Exa
OPENCODE_EXPERIMENTAL_LSP_TYbooleanoHabilitar la verificación de tipo experimental LSP
OPENCODE_EXPERIMENTAL_MARKDOWNbooleanoHabilitar funciones de Markdown experimentales
OPENCODE_EXPERIMENTAL_PLAN_MODEbooleanoHabilitar modo de plan