Référence de la CLI

L'interface en ligne de commande apothem gère les configurations d'adaptateurs d'environnement à partir du profil partagé. Chaque page ci-dessous documente une sous-commande : son synopsis, ses options, son comportement et ses codes de sortie.

Chacune des commandes install, update et uninstall accepte aussi un alias en forme continue (installing, updating, uninstalling), identique à la commande de base en options et en comportement. La mise à jour et la désinstallation via les canaux d'installation — le plugin Claude Code, npx et les scripts d'installation en une seule étape — sont documentées dans les guides d'installation Mise à jour et Désinstallation, et non par les alias eux-mêmes.

CommandesCopy Anchor Link

Contrat de sortie JSONCopy Anchor Link

Chaque commande, à l'exception de completion (qui émet un script shell), accepte --json (raccourci de --format json) et écrit alors exactement un document JSON sur stdout. Chaque document commence par une clé schema_version de premier niveau, un entier qui vaut 1 aujourd'hui :

{"schema_version": 1, "status": "success", "command": "verify", "...": "..."}

• Stabilité. Au sein d'une même schema_version, les changements sont additifs : une nouvelle clé peut apparaître, mais aucune clé n'est renommée ni supprimée et aucune valeur ne change de type. Tout autre changement incrémente schema_version.
• Artefacts versionnés. profile show --json émet le profil lui-même ; son schema_version est donc la version du schéma de profil (également 1 aujourd'hui).
• Une exception. harnesses list --json émet un tableau JSON (un objet par environnement), comme il l'a toujours fait ; il n'a donc aucune clé de premier niveau pour porter la version. L'envelopper dans un objet casserait les analyseurs existants ; tant qu'un changement de version ne le fait pas, traitez sa forme comme schema_version 1.
• Erreurs. Les échecs attendus utilisent la même forme de document avec "status": "error" et un objet error portant code, field, reason et fix.

Codes de sortieCopy Anchor Link

Chaque commande utilise le même petit ensemble de codes de sortie ; chaque page liste ceux qu'elle peut renvoyer.

Une erreur d'utilisation ne touche jamais au système de fichiers. Sous --json (ou --format json), elle affiche un document d'erreur avec "code": "cli.usage" au lieu du texte d'utilisation brut, afin que l'automatisation puisse distinguer une option mal saisie d'une écriture partielle.

Pour les commandes slash et la vue d'ensemble de la CLI de plus haut niveau, consultez les pages de référence Vue d'ensemble de la CLI et Commandes slash.