Skip to content
Apothem
Referencia de la CLI

doctor

Referencia de la CLI para el comando apothem doctor.

Comprueba el estado de lo que está instalado. Mientras que apothem verify comprueba los entornos que seleccionas, doctor comprueba cada entorno instalado y el perfil compartido en una sola pasada.

Sinopsis

apothem doctor [--project PATH] [--quiet|-q] [--verbose|-v]
               [--format plain|json] [--json] [--no-color]

Qué comprueba

  • Perfil compartido. Un perfil presente se valida contra el esquema empaquetado; uno mal formado falla con su código de diagnóstico. Un perfil ausente se informa, no se considera un fallo (install crea uno).
  • Solo los entornos instalados. Un entorno que no está instalado se informa como not_installed y no es un fallo, de modo que una máquina con un solo entorno en buen estado pasa. Los entornos con alcance de proyecto se comprueban cuando --project indica su raíz; sin esta opción se informan como needs_project.
  • Verificación. Cada entorno instalado debe superar la misma comprobación que verify.
  • Tiempo de ejecución de los hooks. Para cada entorno verificado, doctor lee los archivos que escribió su instalación más reciente, encuentra los comandos de hook que Apothem registró allí e inicia cada intérprete y cada script de hook una vez con una carga útil sin efecto (los argumentos registrados más --help, {} en stdin, un directorio de trabajo temporal y PYTHONPATH eliminado). No se escribe nada. Un intérprete ausente, un script ausente o un fallo en el momento de la importación hacen fallar la comprobación.

Cada comprobación fallida indica una corrección. Sale con 0 cuando ninguna comprobación falla y con 1 en caso contrario.

Salida JSON

--json conserva los campos anteriores (version, python, platform, profile_path, profile_exists, profile_valid, harnesses, all_ok, y profile_error cuando el perfil no es válido) y agrega:

  • profile_error_code — el código de diagnóstico del perfil, cuando el perfil no es válido.
  • project — la raíz de --project resuelta, o null.
  • harnesses[].status — ok, not_installed, needs_project, verify_failed, hook_failed o error; además de verified y hooks ({"probed": N, "failed": [...]}, o null cuando no existe ningún registro de instalación).
  • checks — un registro por comprobación: code (por ejemplo harness.verify_failed, hook.start_failed, ledger.unreadable o un código profile.*), status (pass, fail o info), harness, message y fix.
{
  "schema_version": 1,
  "all_ok": false,
  "checks": [
    {
      "code": "hook.start_failed",
      "status": "fail",
      "harness": "claude-code",
      "message": "claude-code: a registered hook command cannot start: …",
      "fix": "Check that the interpreter in the hook command exists and runs, then …"
    }
  ]
}

Opciones

OpciónDescripción
--project PATHRaíz del proyecto para los entornos con alcance de proyecto; sin esta opción se informan como needs_project.
--quiet, -qSuprime la salida informativa; solo se emiten errores.
--verbose, -vSe acepta por coherencia con otros comandos; este comando no imprime salida adicional.
--format plain|jsonFormato de salida (predeterminado: plain).
--jsonAbreviatura de --format json.
--no-colorDesactiva los códigos de color ANSI en la salida.
-h, --helpMuestra la ayuda y sale.

Ejemplos

apothem doctor
apothem doctor --project .
apothem doctor --json

El formato plain predeterminado imprime diagnósticos legibles por personas; --json (equivalente a --format json) emite un documento legible por máquina en stdout, apto para canalizarlo hacia otras herramientas.

Códigos de salida

CódigoSignificado
0Todas las comprobaciones pasaron (también cuando todavía no hay ningún entorno instalado)
1Un entorno instalado no se verifica, un comando de hook registrado no puede iniciarse, un adaptador no pudo cargarse o no pudo sondearse, o un perfil presente no superó la validación del esquema
64Error de uso: una opción o un comando desconocidos, o un valor de opción ausente o no válido. Con --json, el error es un sobre JSON con el código cli.usage.

Véase también

On this page