Referencia de la CLI
Referencia de la CLI de Apothem — sinopsis, opciones y códigos de salida de cada comando de la interfaz de línea de comandos apothem.
La interfaz de línea de comandos apothem gestiona las configuraciones de los
adaptadores de entorno a partir del perfil compartido. Cada página a
continuación documenta un subcomando: su sinopsis, sus opciones, su
comportamiento y sus códigos de salida.
Cada uno de install, update y uninstall acepta también un alias en forma
continua (installing, updating, uninstalling) idéntico al comando base en
indicadores y comportamiento. La actualización y la desinstalación a través de
los canales de instalación — el plugin de Claude Code, npx y los scripts del
instalador de un solo paso — se documentan en las guías de instalación
Actualizar y Desinstalar,
no en los alias en sí.
Comandos
| Comando | Descripción |
|---|---|
| quickstart | Primera ejecución guiada: asegura un perfil, previsualiza las escrituras y luego instala. |
| install | Instala la configuración de un adaptador de entorno a partir del perfil compartido (alias: installing). |
| update | Reinstala la configuración de un adaptador de entorno a partir del perfil compartido actual (alias: updating). |
| uninstall | Elimina la configuración de un adaptador de entorno (alias: uninstalling). |
| rollback | Restaura un entorno al estado anterior a su instalación registrada. |
| backups | Depura las copias de seguridad de instalación y el historial del libro mayor que Apothem conserva (backups prune). |
| verify | Verifica la instalación de un adaptador de entorno. |
| status | Informa el estado de instalación, de verificación y de desviación de cada entorno registrado. |
| diff | Previsualiza los cambios de configuración pendientes para un único entorno. |
| harnesses | Lista e inspecciona los adaptadores de entorno registrados. |
| profile | Gestiona el perfil compartido de Apothem. |
| migrate-workspace | Migra un espacio de trabajo heredado por entorno a la estructura compartida .apothem. |
| doctor | Ejecuta diagnósticos del sistema para la instalación de Apothem. |
| completion | Emite un script de autocompletado de shell que se puede cargar con source (bash, zsh, fish, powershell). |
Contrato de la salida JSON
Cada comando excepto completion (que emite un script de shell) acepta --json
(abreviatura de --format json) y entonces escribe exactamente un documento
JSON en stdout. Cada documento empieza con una clave
schema_version de nivel superior, un entero que hoy vale 1:
{"schema_version": 1, "status": "success", "command": "verify", "...": "..."}- Estabilidad. Dentro de un mismo
schema_version, los cambios son aditivos: puede aparecer una clave nueva, pero ninguna clave se renombra ni se elimina y ningún valor cambia de tipo. Cualquier otro cambio incrementaschema_version. - Artefactos versionados.
profile show --jsonemite el propio perfil, así que suschema_versiones la versión del esquema del perfil (también1hoy). - Una excepción.
harnesses list --jsonemite un arreglo JSON (un objeto por entorno), como siempre lo ha hecho, así que no tiene una clave de nivel superior que lleve la versión. Envolverlo en un objeto rompería los analizadores existentes; hasta que un incremento de versión lo haga, trata su forma comoschema_version1. - Errores. Los fallos previstos usan la misma forma de documento con
"status": "error"y un objetoerrorque llevacode,field,reasonyfix.
Códigos de salida
Todos los comandos usan el mismo conjunto reducido de códigos de salida; cada página lista los que puede devolver.
| Código | Significado |
|---|---|
| 0 | Éxito |
| 1 | Fallo previsto: un error de validación, de perfil, de entorno, de proyecto o de adaptador |
| 2 | Resultado parcial: un lote escribió o eliminó algo antes de un fallo (solo los comandos cuya página lo lista) |
| 64 | Error de uso: una opción o un comando desconocidos, una opción obligatoria ausente o un valor de opción no válido |
Un error de uso nunca toca el sistema de archivos. Con --json (o
--format json) imprime un único documento de error con "code": "cli.usage"
en lugar del texto de uso simple, de modo que la automatización puede distinguir
un indicador mal escrito de una escritura parcial.
Para los comandos slash y la descripción general de la CLI de nivel superior, consulta las páginas de referencia Descripción general de la CLI y Comandos slash.
Disciplina de planes — Memoria de trabajo efímera y local al proyecto
Gestiona la memoria de trabajo efímera y local al proyecto en .apothem/plans/ (un árbol heredado .plans/ se actualiza con apothem migrate-workspace) con esquema de frontmatter, transiciones de ciclo de vida, promoción a ADR y aplicación mediante hooks y validadores.
quickstart
Referencia de la CLI para el comando guiado de primera ejecución apothem quickstart.