CLI
La CLI de CodeTutor de forma predeterminada inicia el TUI cuando se ejecuta sin ningún argumento.
opencodePero también acepta comandos como se documenta en esta página. Esto le permite interactuar con CodeTutor mediante programación.
codetutor run "Explain how closures work in JavaScript"tui
Inicie la interfaz de usuario del terminal CodeTutor.
opencode [project]Opciones
| Opción | Corta | Descripción |
|---|---|---|
--continue | -c | Continuar la última sesión |
--session | -s | ID de sesión para continuar |
--fork | Bifurcar la sesión al continuar (usar con --continue o --session) | |
--prompt | Aviso de uso | |
--model | -m | Modelo a utilizar en forma de proveedor/modelo |
--agent | Agente a utilizar | |
--port | Puerto para escuchar | |
--hostname | Nombre de host para escuchar |
Comandos
La CLI de CodeTutor también tiene los siguientes comandos.
agent
Administrar agentes para CodeTutor.
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.
codetutor attach [url]Esto permite usar TUI con un backend remoto CodeTutor. Por ejemplo:
# Start the backend server for web/mobile accesscodetutor web --port 4096 --hostname 0.0.0.0
# In another terminal, attach the TUI to the running backendcodetutor attach http://10.20.30.40:4096Opciones
| Opción | Corta | Descripción |
|---|---|---|
--dir | Directorio de trabajo para iniciar TUI en | |
--continue | -c | Continuar la última sesión |
--session | -s | ID de sesión para continuar |
--fork | Bifurcar la sesión al continuar (usar con --continue o --session) | |
--password | -p | Contraseña de autenticación básica (predeterminada: CODETUTOR_SERVER_PASSWORD) |
--username | -u | Usuario de autenticación básica (predeterminado: CODETUTOR_SERVER_USERNAME u codetutor) |
create
Cree un nuevo agente con configuración personalizada.
codetutor agent createEste 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.
codetutor agent listauth
Comando para administrar credenciales e iniciar sesión para proveedores.
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.
codetutor auth loginCuando 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.
codetutor auth listO la versión corta.
codetutor auth lslogout
Cierra tu sesión de un proveedor eliminándolo del archivo de credenciales.
codetutor auth logoutgithub
Administre el agente GitHub para la automatización del repositorio.
codetutor github [command]install
Instale el agente GitHub en su repositorio.
codetutor github installEsto 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.
codetutor github runOpciones
| Opción | Descripción |
|---|---|
--event | GitHub evento simulado para ejecutar el agente |
--token | GitHub token de acceso personal |
mcp
Administrar servidores de protocolo de contexto modelo.
codetutor mcp [command]add
Agregue un servidor MCP a su configuración.
codetutor mcp addEste comando lo guiará para agregar un servidor MCP local o remoto.
list
Enumere todos los servidores MCP configurados y su estado de conexión.
codetutor mcp listO utilice la versión corta.
codetutor mcp lsauth
Autentíquese con un servidor MCP habilitado para OAuth.
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.
codetutor mcp auth listO utilice la versión corta.
codetutor mcp auth lslogout
Elimine las credenciales OAuth para un servidor MCP.
codetutor mcp logout [name]debug
Depurar problemas de conexión OAuth para un servidor MCP.
codetutor mcp debug <name>models
Enumere todos los modelos disponibles de los proveedores configurados.
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.
codetutor models anthropicOpciones
| Opción | Descripción |
|---|---|
--refresh | Actualizar la caché de modelos desde models.dev |
--verbose | Utilice 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.
codetutor models --refreshrun
Ejecute codetutor en modo no interactivo pasando un mensaje directamente.
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.
codetutor run Explain the use of context in GoTambié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:
# Start a headless server in one terminalcodetutor serve
# In another terminal, run commands that attach to itcodetutor run --attach http://localhost:4096 "Explain async/await in JavaScript"Opciones
| Opción | Corta | Descripción |
|---|---|---|
--command | El comando a ejecutar, use mensaje para args | |
--continue | -c | Continuar la última sesión |
--session | -s | ID de sesión para continuar |
--fork | Bifurcar la sesión al continuar (usar con --continue o --session) | |
--share | Comparte la sesión | |
--model | -m | Modelo a utilizar en forma de proveedor/modelo |
--agent | Agente a utilizar | |
--file | -f | Archivo(s) para adjuntar al mensaje |
--format | Formato: predeterminado (formateado) o json (eventos JSON sin formato) | |
--title | Título de la sesión (utiliza un mensaje truncado si no se proporciona ningún valor) | |
--attach | Adjuntar a un servidor codetutor en ejecución (por ejemplo, http://localhost:4096) | |
--password | -p | Contraseña de autenticación básica (predeterminada: CODETUTOR_SERVER_PASSWORD) |
--username | -u | Usuario de autenticación básica (predeterminado: CODETUTOR_SERVER_USERNAME u codetutor) |
--dir | Directorio de ejecución, o ruta en el servidor remoto al adjuntar | |
--variant | Variante del modelo (esfuerzo de razonamiento específico del proveedor) | |
--thinking | Mostrar bloques de pensamiento | |
--port | Puerto 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.
codetutor serveEsto 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ón | Descripción |
|---|---|
--port | Puerto para escuchar |
--hostname | Nombre de host para escuchar |
--mdns | Habilitar el descubrimiento de mDNS |
--cors | Orígenes de navegador adicionales para permitir CORS |
session
Administrar CodeTutor sesiones.
codetutor session [command]list
Enumere todas las sesiones CodeTutor.
codetutor session listOpciones
| Opción | Corta | Descripción |
|---|---|---|
--max-count | -n | Limitar a N sesiones más recientes |
--format | Formato de salida: tabla o json (tabla) |
stats
Muestre el uso de tokens y las estadísticas de costos para sus sesiones CodeTutor.
codetutor statsOpciones
| Opción | Descripción |
|---|---|
--days | Mostrar estadísticas de los últimos N días (todo el tiempo) |
--tools | Número de herramientas para mostrar (todas) |
--models | Mostrar el desglose del uso del modelo (oculto de forma predeterminada). Pase un número para mostrar la parte superior N |
--project | Filtrar por proyecto (todos los proyectos, cadena vacía: proyecto actual) |
export
Exportar datos de la sesión como JSON.
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.
codetutor import <file>Puede importar desde un archivo local o una URL compartida CodeTutor.
codetutor import session.jsoncodetutor import https://opncd.ai/s/abc123web
Inicie un servidor CodeTutor sin cabeza con una interfaz web.
codetutor webEsto 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ón | Descripción |
|---|---|
--port | Puerto para escuchar |
--hostname | Nombre de host para escuchar |
--mdns | Habilitar el descubrimiento de mDNS |
--cors | Orígenes de navegador adicionales para permitir CORS |
acp
Inicie un servidor ACP (Agent Client Protocol).
codetutor acpEste comando inicia un servidor ACP que se comunica a través de stdin/stdout usando nd-JSON.
Opciones
| Opción | Descripción |
|---|---|
--cwd | Directorio de trabajo |
--port | Puerto para escuchar |
--hostname | Nombre de host para escuchar |
uninstall
Desinstale CodeTutor y elimine todos los archivos relacionados.
codetutor uninstallOpciones
| Opción | Corta | Descripción |
|---|---|---|
--keep-config | -c | Mantener archivos de configuración |
--keep-data | -d | Conservar datos de sesión e instantáneas |
--dry-run | Mostrar lo que se eliminaría sin eliminar | |
--force | -f | Saltar mensajes de confirmación |
upgrade
Actualiza codetutor a la última versión o a una versión específica.
codetutor upgrade [target]Para actualizar a la última versión.
codetutor upgradePara actualizar a una versión específica.
codetutor upgrade v0.1.48Opciones
| Opción | Corta | Descripción |
|---|---|---|
--method | -m | El 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ón | Corta | Descripción |
|---|---|---|
--help | -h | Mostrar ayuda |
--version | -v | Número de versión de impresión |
--print-logs | Imprimir registros en stderr | |
--log-level | Nivel de registro (DEBUG, INFO, WARN, ERROR) |
Variables de entorno
CodeTutor se puede configurar mediante variables de entorno.
| Variable | Type | Description |
|---|---|---|
CODETUTOR_AUTO_SHARE | booleano | Compartir sesiones automáticamente |
CODETUTOR_GIT_BASH_PATH | cadena | Ruta al ejecutable de Git Bash en Windows |
CODETUTOR_CONFIG | cadena | Ruta al archivo de configuración |
CODETUTOR_CONFIG_DIR | cadena | Ruta al directorio de configuración |
CODETUTOR_CONFIG_CONTENT | cadena | Contenido de configuración json en línea |
CODETUTOR_DISABLE_AUTOUPDATE | booleano | Deshabilitar las comprobaciones automáticas de actualizaciones |
CODETUTOR_DISABLE_PRUNE | booleano | Deshabilitar la poda de datos antiguos |
CODETUTOR_DISABLE_TERMINAL_TITLE | booleano | Deshabilitar las actualizaciones automáticas de títulos de terminal |
CODETUTOR_PERMISSION | cadena | Configuración de permisos json incorporados |
CODETUTOR_DISABLE_DEFAULT_PLUGINS | booleano | Deshabilitar complementos predeterminados |
CODETUTOR_DISABLE_LSP_DOWNLOAD | booleano | Deshabilitar las descargas automáticas del servidor LSP |
CODETUTOR_ENABLE_EXPERIMENTAL_MODELS | booleano | Habilitar modelos experimentales |
CODETUTOR_DISABLE_AUTOCOMPACT | booleano | Deshabilitar la compactación automática de contexto |
CODETUTOR_DISABLE_CLAUDE_CODE | booleano | Deshabilitar la lectura desde .claude (mensaje + habilidades) |
CODETUTOR_DISABLE_CLAUDE_CODE_PROMPT | booleano | Desactivar lectura ~/.claude/CLAUDE.md |
CODETUTOR_DISABLE_CLAUDE_CODE_SKILLS | booleano | Deshabilitar la carga .claude/skills |
CODETUTOR_DISABLE_MODELS_FETCH | booleano | Deshabilitar la recuperación de modelos desde fuentes remotas |
CODETUTOR_FAKE_VCS | cadena | Proveedor de VCS falso para fines de prueba |
CODETUTOR_CLIENT | cadena | Identificador de cliente (por defecto cli) |
CODETUTOR_ENABLE_EXA | booleano | Habilitar las herramientas de búsqueda web de Exa |
CODETUTOR_SERVER_PASSWORD | cadena | Habilite la autenticación básica para serve/web |
CODETUTOR_SERVER_USERNAME | cadena | Anular el nombre de usuario de autenticación básica (predeterminado codetutor) |
CODETUTOR_MODELS_URL | cadena | URL personalizada para buscar la configuración de modelos |
Experimental
Estas variables de entorno habilitan funciones experimentales que pueden cambiar o eliminarse.
| Variable | Type | Description |
|---|---|---|
CODETUTOR_EXPERIMENTAL | booleano | Habilitar funciones experimentales de la bandera global |
CODETUTOR_EXPERIMENTAL_ICON_DISCOVERY | booleano | Habilitar descubrimiento de íconos |
CODETUTOR_EXPERIMENTAL_DISABLE_COPY_ON_SELECT | booleano | Deshabilitar copia al seleccionar en TUI |
CODETUTOR_EXPERIMENTAL_BASH_DEFAULT_TIMEOUT_MS | número | Tiempo de espera predeterminado para comandos bash en ms |
CODETUTOR_EXPERIMENTAL_OUTPUT_TOKEN_MAX | número | Tokens de salida máximos para respuestas LLM |
CODETUTOR_EXPERIMENTAL_FILEWATCHER | booleano | Habilite el observador de archivos para todo el directorio |
CODETUTOR_EXPERIMENTAL_OXFMT | booleano | Habilitar el formateador oxfmt |
CODETUTOR_EXPERIMENTAL_LSP_TOOL | booleano | Habilitar herramienta experimental LSP |
CODETUTOR_EXPERIMENTAL_DISABLE_FILEWATCHER | booleano | Deshabilitar el observador de archivos |
CODETUTOR_EXPERIMENTAL_EXA | booleano | Habilitar funciones experimentales de Exa |
CODETUTOR_EXPERIMENTAL_LSP_TY | booleano | Habilitar Habilitar TY LSP para archivos python |
CODETUTOR_EXPERIMENTAL_PLAN_MODE | booleano | Habilitar modo de plan |
CODETUTOR_EXPERIMENTAL_BACKGROUND_SUBAGENTS | booleano | Habilitar tareas de subagentes en segundo plano |
CODETUTOR_EXPERIMENTAL_EVENT_SYSTEM | booleano | Habilitar sistema de eventos experimental |
CODETUTOR_EXPERIMENTAL_NATIVE_LLM | booleano | Habilitar ruta nativa de solicitud LLM |
CODETUTOR_EXPERIMENTAL_PARALLEL | booleano | Habilitar ejecución paralela de búsqueda web |
CODETUTOR_EXPERIMENTAL_SCOUT | booleano | Habilitar subagente Scout |
CODETUTOR_EXPERIMENTAL_WORKSPACES | booleano | Habilitar soporte de espacios de trabajo |