quickstart

Referencia de la CLI para el comando guiado de primera ejecución apothem quickstart.

Primera ejecución guiada: asegura que exista un perfil, previsualiza las escrituras y luego instala.

Sinopsis

apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
                   [--yes] [--quiet|-q] [--verbose|-v]
                   [--format plain|json] [--json] [--no-color]

quickstart es el único punto de entrada guiado para un operador nuevo. En un solo flujo lineal: (1) asegura que exista un perfil compartido — y crea un perfil inicial con una invitación a personalizarlo si no encuentra ninguno; (2) previsualiza los archivos concretos que escribirán los entornos seleccionados, agrupados en raíz del proyecto frente a tu directorio personal; (3) pide confirmación; (4) instala con la salida de notas de capacidades agrupada y sin ruido; y (5) imprime los comandos siguientes recomendados.

Compone los mismos bloques de construcción que usa el comando install; no los reimplementa. --project tiene como valor predeterminado el directorio actual. --harness no tiene valor predeterminado: cuando se omite, quickstart pregunta qué entorno instalar, de modo que una primera ejecución escribe la configuración de un solo entorno. --harness all instala todos los entornos admitidos y es siempre una elección explícita.

Comportamiento

Entorno — sin --harness, una ejecución interactiva lista los nombres admitidos (además de all) y pide uno antes de escribir nada. Una ejecución que no puede preguntar — --yes, --format json o sin terminal — se detiene con un error de uso que nombra la opción --harness, y no escribe nada.
Perfil — si la ruta de perfil resuelta no tiene archivo, quickstart ofrece crear un perfil inicial (lo crea automáticamente con --yes, en una shell no interactiva o con --format json) y nombra los campos de identidad de marcador de posición que hay que personalizar.
Vista previa + confirmación — con --harness all, los destinos se listan bajo dos encabezados (raíz del proyecto frente a tu directorio personal), y una ejecución interactiva confirma antes de escribir fuera del proyecto. Un único entorno indicado por nombre se instala sin vista previa ni solicitud. --yes, una shell no interactiva y --format json continúan sin preguntar. Rechazar la vista previa de --harness all aborta antes de las escrituras de instalación; un perfil inicial creado en el paso 1 se conserva.
Instalación — las capacidades que un entorno no admite de forma nativa se resumen en una nota agrupada por entorno (pasa --verbose para ver el detalle por capacidad); el conjunto completo siempre está en el arreglo warnings de --format json.
Siguiente paso — la salida de la terminal nombra los comandos siguientes (apothem verify …, apothem doctor).

Opciones

Opción	Descripción
`--harness NAME`	Adaptador de entorno que se instala, o `all` para el conjunto de todo el registro. Sin valor predeterminado: una ejecución interactiva lo pregunta; una ejecución no interactiva debe pasarlo.
`--profile PATH`	Ruta al YAML del perfil compartido. Valor predeterminado: `~/.config/apothem/profile.yaml`.
`--project PATH`	Raíz del proyecto para los entornos de alcance de proyecto. Valor predeterminado: el directorio actual.
`--yes`	Ejecuta la secuencia guiada completa de forma no interactiva (omite todas las solicitudes).
`--quiet`, `-q`	Suprime la salida informativa; solo se emiten errores.
`--verbose`, `-v`	Imprime la justificación de cada capacidad no proyectada en lugar de la nota agrupada.
`--format plain\|json`	Formato de salida (predeterminado: `plain`).
`--json`	Abreviatura de `--format json`.
`--no-color`	Desactiva los códigos de color ANSI en la salida.
`-h`, `--help`	Muestra la ayuda y sale.

Salida JSON

--format json emite un único documento que resume cada paso guiado:

{
  "schema_version": 1,
  "status": "success",
  "command": "quickstart",
  "profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
  "steps": [
    {"step": "profile", "outcome": "created", "path": "…", "placeholder_identity": ["name", "email", "github"]},
    {"step": "install", "status": "success", "harness": "all", "files_written": ["…"], "warnings": [], "results": []},
    {"step": "recommend", "next": ["apothem verify --harness all --project .", "apothem doctor"]}
  ],
  "recommended_next": ["apothem verify --harness all --project .", "apothem doctor"]
}

Ejemplos

apothem quickstart                                  # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes  # every harness, explicitly
apothem quickstart --harness claude-code --json

Códigos de salida

Código	Significado
0	Ejecución guiada completada
1	Error previsto de validación, de perfil, de entorno, de proyecto o de adaptador
2	Materialización parcial del lote después de al menos una escritura
64	Error 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

apothem install — materializa un entorno a partir del perfil compartido
apothem verify — confirma que una instalación está activa
apothem doctor — salud del entorno del sistema y de la instalación
Primeros pasos — guía de instalación completa

quickstart

SinopsisCopy Anchor Link

ComportamientoCopy Anchor Link

OpcionesCopy Anchor Link

Salida JSONCopy Anchor Link

EjemplosCopy Anchor Link

Códigos de salidaCopy Anchor Link

Véase tambiénCopy Anchor Link