quickstart

Référence de la CLI pour la commande de première exécution guidée apothem quickstart.

Première exécution guidée : garantit l'existence d'un profil, prévisualise les écritures, puis installe.

Synopsis

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

quickstart est l'unique point d'entrée guidé pour un nouvel opérateur. En un seul flux linéaire, la commande : (1) garantit l'existence d'un profil partagé — en créant un profil de démarrage accompagné d'une invitation à le personnaliser si aucun n'est trouvé ; (2) prévisualise les fichiers concrets que les environnements sélectionnés écriront, regroupés selon la racine du projet ou votre répertoire personnel ; (3) demande une confirmation ; (4) installe avec la sortie groupée et épurée des notes de capacités ; et (5) affiche les commandes suivantes recommandées.

Elle assemble les mêmes briques que la commande install — elle ne les réimplémente pas. --project vaut par défaut le répertoire courant. --harness n'a pas de valeur par défaut : lorsqu'il est omis, quickstart demande quel environnement installer, de sorte qu'une première exécution écrit la configuration d'un seul environnement. --harness all installe chaque environnement pris en charge et relève toujours d'un choix explicite.

Comportement

Environnement — sans --harness, une exécution interactive liste les noms pris en charge (plus all) et en demande un avant toute écriture. Une exécution qui ne peut pas poser la question — --yes, --format json ou absence de terminal — s'arrête sur une erreur d'utilisation qui nomme l'option --harness, et n'écrit rien.
Profil — si le chemin de profil résolu ne contient aucun fichier, quickstart propose de créer un profil de démarrage (création automatique avec --yes, dans un shell non interactif ou avec --format json) et nomme les champs d'identité provisoires à personnaliser.
Aperçu + confirmation — pour --harness all, les cibles sont listées sous deux en-têtes (racine du projet et répertoire personnel) ; une exécution interactive demande confirmation avant d'écrire en dehors du projet. Un environnement nommé seul est installé sans aperçu ni invite. --yes, un shell non interactif et --format json poursuivent sans demander de confirmation. Refuser l'aperçu de --harness all interrompt l'installation avant toute écriture ; un profil de démarrage créé à l'étape 1 est conservé.
Installation — les capacités qu'un environnement ne prend pas en charge nativement sont résumées en une note groupée par environnement (passez --verbose pour le détail par capacité) ; l'ensemble complet figure toujours dans le tableau des avertissements (warnings) de la sortie --format json.
Étape suivante — la sortie du terminal nomme les commandes à lancer ensuite (apothem verify …, apothem doctor).

Options

Option	Description
`--harness NAME`	Adaptateur d'environnement à installer, ou `all` pour l'ensemble couvrant tout le registre. Aucune valeur par défaut : une exécution interactive le demande ; une exécution non interactive doit le passer.
`--profile PATH`	Chemin vers le YAML du profil partagé. Par défaut : `~/.config/apothem/profile.yaml`.
`--project PATH`	Racine du projet pour les environnements à portée de projet. Par défaut : le répertoire courant.
`--yes`	Exécute la séquence guidée complète de façon non interactive (ignore chaque invite).
`--quiet`, `-q`	Supprime la sortie informative ; seules les erreurs sont émises.
`--verbose`, `-v`	Affiche la justification de chaque capacité non projetée au lieu de la note groupée.
`--format plain\|json`	Format de sortie (par défaut : `plain`).
`--json`	Raccourci de `--format json`.
`--no-color`	Désactive les codes de couleur ANSI dans la sortie.
`-h`, `--help`	Affiche l'aide et quitte.

Sortie JSON

--format json émet un seul document qui résume chaque étape guidée :

{
  "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"]
}

Exemples

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

Codes de sortie

Code	Signification
0	Exécution guidée terminée
1	Erreur attendue de validation, de profil, d'environnement, de projet ou d'adaptateur
2	Matérialisation partielle du lot après au moins une écriture
64	Erreur d'utilisation : une option ou une commande inconnue, ou une valeur d'option manquante ou invalide. Sous `--json`, l'erreur est une enveloppe JSON avec le code `cli.usage`.

Voir aussi

apothem install — matérialise un environnement à partir du profil partagé
apothem verify — confirme qu'une installation est active
apothem doctor — état de santé de l'environnement hôte et de l'installation
Premiers pas — guide d'installation complet

quickstart

SynopsisCopy Anchor Link

ComportementCopy Anchor Link

OptionsCopy Anchor Link

Sortie JSONCopy Anchor Link

ExemplesCopy Anchor Link

Codes de sortieCopy Anchor Link

Voir aussiCopy Anchor Link