Référence de la CLI
Référence de la CLI d'Apothem — toutes les sous-commandes et options.
La CLI apothem est l'interface principale de l'opérateur pour gérer le profil
partagé et les adaptateurs d'environnement.
Options globales
| Option | Description |
|---|---|
--version | Affiche la version d'Apothem et quitte |
--help | Affiche l'aide de la commande |
Sous-commandes
apothem install
Installe un adaptateur d'environnement depuis le profil partagé.
apothem install --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]| Option | Description |
|---|---|
--harness <name> | Nom de l'adaptateur d'environnement (voir les valeurs canoniques ci-dessous). Obligatoire. |
--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. |
--dry-run | Prévisualise l'installation sans écrire de fichiers. |
Valeurs canoniques de --harness :
antigravity
claude-code
codebuddy
codex
cursor
gemini-cli
github-copilot
hermes
kiro
open-claw
opencode
qwen-code
trae
windsurf
zedUtilisez --harness all --project <path> pour sélectionner l'ensemble complet du
registre. La liste exclude_harnesses du profil est respectée pendant la
sélection par lot d'installation/mise à jour.
apothem update
Re-dérive la configuration native d'un adaptateur d'environnement à partir du profil partagé actuel.
apothem update --harness <name|all> [--profile PATH] [--project PATH] [--dry-run]| Option | Description |
|---|---|
--harness <name> | Nom de l'adaptateur d'environnement. Obligatoire. |
--profile PATH | Chemin vers le YAML du profil partagé. |
--project PATH | Racine du projet pour les environnements à portée de projet. |
--dry-run | Prévisualise la mise à jour sans écrire de fichiers. |
update rematérialise la sortie de l'environnement. Elle ne met pas à jour le
paquet de la CLI d'Apothem ; pour les mises à niveau du paquet, utilisez le
gestionnaire de paquets ayant servi à installer Apothem.
apothem uninstall
Supprime la configuration native d'un adaptateur d'environnement.
apothem uninstall --harness <name|all> [--project PATH] [--yes]| Option | Description |
|---|---|
--harness <name> | Nom de l'adaptateur d'environnement. Obligatoire. |
--project PATH | Racine du projet pour les environnements à portée de projet. |
--yes | Ignore l'invite de confirmation. |
apothem verify
Vérifie qu'un adaptateur d'environnement est installé et que son chemin de sortie est présent.
apothem verify --harness <name|all> [--project PATH]| Option | Description |
|---|---|
--harness <name> | Nom de l'adaptateur d'environnement ou all. Obligatoire. |
--project PATH | Racine du projet pour les environnements à portée de projet. |
Le code de sortie est 0 lorsque l'adaptateur est installé, et 1 lorsqu'il ne
l'est pas.
apothem profile
Gère le profil partagé d'Apothem.
apothem profile show [--profile PATH]
apothem profile init [--profile PATH] [--force]
apothem profile set <key> <value> [--profile PATH]
apothem profile edit [--profile PATH]| Sous-commande | Description |
|---|---|
profile init | Crée un échafaudage de profil minimal valide selon le schéma. |
profile show | Affiche le profil résolu (YAML) sur stdout. |
profile set <key> <value> | Définit un champ du profil. La valeur est analysée en YAML (chaînes, nombres, booléens, listes et mappages sont tous acceptés). |
profile edit | Ouvre le profil dans $EDITOR (à défaut, l'éditeur par défaut de la plateforme). |
L'option --profile PATH dirige chaque sous-commande vers un autre fichier de
profil. Par défaut, ~/.config/apothem/profile.yaml.
apothem harnesses
Liste et inspecte les adaptateurs d'environnement enregistrés.
apothem harnesses list
apothem harnesses show <name>| Sous-commande | Description |
|---|---|
harnesses list | Affiche un tableau de chaque adaptateur enregistré avec son indicateur d'état d'installation et son chemin de sortie. |
harnesses show <name> | Affiche le nom, l'état d'installation et le chemin de sortie d'un adaptateur. |
apothem doctor
Exécute les diagnostics système pour l'installation d'Apothem.
apothem doctorAffiche la version d'Apothem, l'interpréteur Python, la plateforme, le chemin du
profil résolu et un tableau d'état d'installation par environnement. Le code de
sortie est 0 lorsque chaque adaptateur enregistré se déclare installé ; sinon,
1.
Référence générée des commandes et options
| Command | Flags | Description |
|---|---|---|
apothem completion | — | Print a shell-completion script for SHELL to stdout. Supported shells: bash, zsh, fish, powershell. Every script is generated by Click's env-var completion protocol — PowerShell through the completion class registered above, since Click ships none natively. Enabling completion is opt-in: this command only prints the script — pipe or append it to the shell's completion file yourself (see --help). |
apothem diff | --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Preview the pending configuration changes for a single harness. |
apothem doctor | --format, --json, --no-color, --quiet, -q, --verbose, -v | Report Apothem environment and installation health, exiting non-zero on any failure. Prints the engine version, Python, and platform, validates the shared profile against the packaged schema — a present-but-malformed profile is a failure, not a green "found" — and probes every registered adapter's install state. An adapter that raises degrades to an error row rather than aborting the sweep. Any failed check — an invalid profile, or a harness that is uninstalled or could not be probed — forces a non-zero exit so a CI or setup step can gate on it. |
apothem harnesses list | --format, --json, --no-color, --quiet, -q, --verbose, -v | List all registered harness adapters. |
apothem harnesses show | --format, --json, --no-color, --quiet, -q, --verbose, -v | Show details for a specific harness adapter. |
apothem install | --clean, --fresh, --dry-run, --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v, --yes | Install a harness adapter configuration. |
apothem migrate-workspace | --dry-run, --format, --json, --no-color, --project, --quiet, -q, --verbose, -v | Migrate a legacy per-harness workspace into the shared .apothem layout. The base is the resolved --project root when supplied, otherwise the current working directory (the project-local default). Per-harness memory/contexts/learning stores union-merge into the shared store; a conflicting record is skipped, never overwritten; a legacy .plans tree moves under .apothem/plans; every consumed source is backed up first. The migration is idempotent. |
apothem profile edit | --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Open the shared profile in the system editor. |
apothem profile init | --force, --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Create a schema-valid shared profile scaffold. |
apothem profile set | --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Set a key in the shared profile. KEY is a dotted path that descends into the nested profile structure (identity.name, preferences.style, enforcement.sprints, harnesses.<harness>.preferences.style); a single key with no dot sets a top-level node. VALUE is stored as a literal string — bare words are not coerced (no stays "no", 2024-01-01 and 1.0 stay strings) — except true/false (the boolean enforcement flags) and explicit [...]/{...} list/map input. The fully-assembled profile is validated against the packaged schema BEFORE writing; an invalid set is refused with the standard diagnostic and the profile on disk is unchanged. |
apothem profile show | --format, --json, --no-color, --profile, --quiet, -q, --verbose, -v | Display the current shared profile. |
apothem quickstart | --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v, --yes | Guided first run: ensure a profile, preview the writes, then install. Walks a new operator through the canonical path in one linear flow — create a starter profile if none exists (with a personalize nudge), preview the files each harness will write (project root vs your home directory), confirm, then install with the grouped capability-note output — and ends with the recommended next commands. --yes runs the whole sequence non-interactively; --format json emits one structured summary of every step. It composes the install building blocks; it does not duplicate them. |
apothem rollback | --format, --harness, --install-id, --json, --last, --no-color, --project, --quiet, -q, --verbose, -v, --yes | Restore a harness to the state before its recorded install. |
apothem status | --format, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Report install, verify, and drift state for every registered harness. |
apothem uninstall | --format, --harness, --json, --no-color, --project, --quiet, -q, --verbose, -v, --yes | Remove a harness adapter configuration. |
apothem update | --dry-run, --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Re-install a harness adapter configuration from the current profile. |
apothem verify | --format, --harness, --json, --no-color, --profile, --project, --quiet, -q, --verbose, -v | Verify a harness adapter installation. Without --profile the check is structural: every managed target must be present and valid. With --profile the check additionally requires profile fidelity, so a present-but-drifted install fails verify — answering "is THIS profile faithfully installed?" rather than merely "does it exist?". |
Référence
Registre navigable des classes d'artefact avec les chemins et les dispositions sur disque pour les règles, commandes, skills, travailleurs délégués, hooks, serveurs MCP, paramètres et styles de sortie.
Champs du profil
Référence générée depuis la source pour chaque champ du schéma du profil partagé d'Apothem.