Saltearse al contenido

CLI

La CLI de CodeTutor 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 CodeTutor mediante programación.

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

tui

Inicie la interfaz de usuario del terminal CodeTutor.

Ventana de terminal
opencode [project]

Opciones

OpciónCortaDescripción
--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

La CLI de CodeTutor también tiene los siguientes comandos.


agent

Administrar agentes para CodeTutor.

Ventana de terminal
codetutor agent [command]

attach

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

Ventana de terminal
codetutor attach [url]

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

Ventana de terminal
# Start the backend server for web/mobile access
codetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backend
codetutor attach http://10.20.30.40:4096

Opciones

OpciónCortaDescripción
--dirDirectorio de trabajo para iniciar TUI en
--continue-cContinuar la última sesión
--session-sID de sesión para continuar
--forkBifurcar la sesión al continuar (usar con --continue o --session)
--password-pContraseña de autenticación básica (predeterminada: CODETUTOR_SERVER_PASSWORD)
--username-uUsuario de autenticación básica (predeterminado: CODETUTOR_SERVER_USERNAME u codetutor)

create

Cree un nuevo agente con configuración personalizada.

Ventana de terminal
codetutor 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
codetutor agent list

auth

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

Ventana de terminal
codetutor auth [command]

login

CodeTutor funciona con la lista de proveedores en Models.dev, por lo que puede usar codetutor 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
codetutor auth login

Cuando se inicia CodeTutor, 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
codetutor auth list

O la versión corta.

Ventana de terminal
codetutor auth ls

logout

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

Ventana de terminal
codetutor auth logout

github

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

Ventana de terminal
codetutor github [command]

install

Instale el agente GitHub en su repositorio.

Ventana de terminal
codetutor 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
codetutor github run
Opciones
OpciónDescripción
--eventGitHub evento simulado para ejecutar el agente
--tokenGitHub token de acceso personal

mcp

Administrar servidores de protocolo de contexto modelo.

Ventana de terminal
codetutor mcp [command]

add

Agregue un servidor MCP a su configuración.

Ventana de terminal
codetutor 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
codetutor mcp list

O utilice la versión corta.

Ventana de terminal
codetutor mcp ls

auth

Autentíquese con un servidor MCP habilitado para OAuth.

Ventana de terminal
codetutor 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
codetutor mcp auth list

O utilice la versión corta.

Ventana de terminal
codetutor mcp auth ls

logout

Elimine las credenciales OAuth para un servidor MCP.

Ventana de terminal
codetutor mcp logout [name]

debug

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

Ventana de terminal
codetutor mcp debug <name>

models

Enumere todos los modelos disponibles de los proveedores configurados.

Ventana de terminal
codetutor 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
codetutor models anthropic

Opciones

OpciónDescripción
--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 CodeTutor.

Ventana de terminal
codetutor models --refresh

run

Ejecute codetutor en modo no interactivo pasando un mensaje directamente.

Ventana de terminal
codetutor 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
codetutor run Explain the use of context in Go

También puede conectarse a una instancia codetutor 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
codetutor serve
# In another terminal, run commands that attach to it
codetutor run --attach http://localhost:4096 "Explain async/await in JavaScript"

Opciones

OpciónCortaDescripción
--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 codetutor en ejecución (por ejemplo, http://localhost:4096)
--password-pContraseña de autenticación básica (predeterminada: CODETUTOR_SERVER_PASSWORD)
--username-uUsuario de autenticación básica (predeterminado: CODETUTOR_SERVER_USERNAME u codetutor)
--dirDirectorio de ejecución, o ruta en el servidor remoto al adjuntar
--variantVariante del modelo (esfuerzo de razonamiento específico del proveedor)
--thinkingMostrar bloques de pensamiento
--portPuerto para el servidor local (el puerto predeterminado es aleatorio)

serve

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

Ventana de terminal
codetutor serve

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

Opciones

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

session

Administrar CodeTutor sesiones.

Ventana de terminal
codetutor session [command]

list

Enumere todas las sesiones CodeTutor.

Ventana de terminal
codetutor session list
Opciones
OpciónCortaDescripción
--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 CodeTutor.

Ventana de terminal
codetutor stats

Opciones

OpciónDescripción
--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
codetutor 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 CodeTutor.

Ventana de terminal
codetutor import <file>

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

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

web

Inicie un servidor CodeTutor sin cabeza con una interfaz web.

Ventana de terminal
codetutor web

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

Opciones

OpciónDescripció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
codetutor acp

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

Opciones

OpciónDescripción
--cwdDirectorio de trabajo
--portPuerto para escuchar
--hostnameNombre de host para escuchar

uninstall

Desinstale CodeTutor y elimine todos los archivos relacionados.

Ventana de terminal
codetutor uninstall

Opciones

OpciónCortaDescripción
--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 codetutor a la última versión o a una versión específica.

Ventana de terminal
codetutor upgrade [target]

Para actualizar a la última versión.

Ventana de terminal
codetutor upgrade

Para actualizar a una versión específica.

Ventana de terminal
codetutor upgrade v0.1.48

Opciones

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

Opciones globales

La CLI de CodeTutor toma las siguientes banderas globales.

OpciónCortaDescripció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

CodeTutor se puede configurar mediante variables de entorno.

VariableTypeDescription
CODETUTOR_AUTO_SHAREbooleanoCompartir sesiones automáticamente
CODETUTOR_GIT_BASH_PATHcadenaRuta al ejecutable de Git Bash en Windows
CODETUTOR_CONFIGcadenaRuta al archivo de configuración
CODETUTOR_CONFIG_DIRcadenaRuta al directorio de configuración
CODETUTOR_CONFIG_CONTENTcadenaContenido de configuración json en línea
CODETUTOR_DISABLE_AUTOUPDATEbooleanoDeshabilitar las comprobaciones automáticas de actualizaciones
CODETUTOR_DISABLE_PRUNEbooleanoDeshabilitar la poda de datos antiguos
CODETUTOR_DISABLE_TERMINAL_TITLEbooleanoDeshabilitar las actualizaciones automáticas de títulos de terminal
CODETUTOR_PERMISSIONcadenaConfiguración de permisos json incorporados
CODETUTOR_DISABLE_DEFAULT_PLUGINSbooleanoDeshabilitar complementos predeterminados
CODETUTOR_DISABLE_LSP_DOWNLOADbooleanoDeshabilitar las descargas automáticas del servidor LSP
CODETUTOR_ENABLE_EXPERIMENTAL_MODELSbooleanoHabilitar modelos experimentales
CODETUTOR_DISABLE_AUTOCOMPACTbooleanoDeshabilitar la compactación automática de contexto
CODETUTOR_DISABLE_CLAUDE_CODEbooleanoDeshabilitar la lectura desde .claude (mensaje + habilidades)
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPTbooleanoDesactivar lectura ~/.claude/CLAUDE.md
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLSbooleanoDeshabilitar la carga .claude/skills
CODETUTOR_DISABLE_MODELS_FETCHbooleanoDeshabilitar la recuperación de modelos desde fuentes remotas
CODETUTOR_FAKE_VCScadenaProveedor de VCS falso para fines de prueba
CODETUTOR_CLIENTcadenaIdentificador de cliente (por defecto cli)
CODETUTOR_ENABLE_EXAbooleanoHabilitar las herramientas de búsqueda web de Exa
CODETUTOR_SERVER_PASSWORDcadenaHabilite la autenticación básica para serve/web
CODETUTOR_SERVER_USERNAMEcadenaAnular el nombre de usuario de autenticación básica (predeterminado codetutor)
CODETUTOR_MODELS_URLcadenaURL personalizada para buscar la configuración de modelos

Experimental

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

VariableTypeDescription
CODETUTOR_EXPERIMENTALbooleanoHabilitar funciones experimentales de la bandera global
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERYbooleanoHabilitar descubrimiento de íconos
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECTbooleanoDeshabilitar copia al seleccionar en TUI
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MSnúmeroTiempo de espera predeterminado para comandos bash en ms
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAXnúmeroTokens de salida máximos para respuestas LLM
CODETUTOR_EXPERIMENTAL_FILEWATCHERbooleanoHabilite el observador de archivos para todo el directorio
CODETUTOR_EXPERIMENTAL_OXFMTbooleanoHabilitar el formateador oxfmt
CODETUTOR_EXPERIMENTAL_LSP_TOOLbooleanoHabilitar herramienta experimental LSP
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHERbooleanoDeshabilitar el observador de archivos
CODETUTOR_EXPERIMENTAL_EXAbooleanoHabilitar funciones experimentales de Exa
CODETUTOR_EXPERIMENTAL_LSP_TYbooleanoHabilitar Habilitar TY LSP para archivos python
CODETUTOR_EXPERIMENTAL_PLAN_MODEbooleanoHabilitar modo de plan
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTSbooleanoHabilitar tareas de subagentes en segundo plano
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEMbooleanoHabilitar sistema de eventos experimental
CODETUTOR_EXPERIMENTAL_NATIVE_LLMbooleanoHabilitar ruta nativa de solicitud LLM
CODETUTOR_EXPERIMENTAL_PARALLELbooleanoHabilitar ejecución paralela de búsqueda web
CODETUTOR_EXPERIMENTAL_SCOUTbooleanoHabilitar subagente Scout
CODETUTOR_EXPERIMENTAL_WORKSPACESbooleanoHabilitar soporte de espacios de trabajo