CLI-Referenz
Apothem-CLI-Referenz — Übersicht, Optionen und Exit-Codes je Befehl für die apothem-Befehlszeilenschnittstelle.
Die apothem-Befehlszeilenschnittstelle verwaltet Harness-Adapterkonfigurationen
aus dem gemeinsamen Profil. Jede der folgenden Seiten dokumentiert einen
Unterbefehl: seine Übersicht, seine Optionen, sein Verhalten und seine Exit-Codes.
Jeder der Befehle install, update und uninstall akzeptiert außerdem einen
Alias in Verlaufsform (installing, updating, uninstalling), der in Flags
und Verhalten mit dem Basisbefehl identisch ist. Das Aktualisieren und
Deinstallieren über die Installationskanäle — das Claude Code-Plugin, npx und
die Ein-Schritt-Installer-Skripte — ist in den Installationsleitfäden
Aktualisieren und
Deinstallieren dokumentiert, nicht durch die
Aliase selbst.
Befehle
| Befehl | Beschreibung |
|---|---|
| quickstart | Geführter erster Lauf: ein Profil sicherstellen, die Schreibvorgänge in der Vorschau anzeigen, dann installieren. |
| install | Eine Harness-Adapterkonfiguration aus dem gemeinsamen Profil installieren (Alias: installing). |
| update | Eine Harness-Adapterkonfiguration aus dem aktuellen gemeinsamen Profil neu installieren (Alias: updating). |
| uninstall | Eine Harness-Adapterkonfiguration entfernen (Alias: uninstalling). |
| rollback | Einen Harness in den Zustand vor seiner aufgezeichneten Installation zurückversetzen. |
| backups | Die Installations-Backups und den Ledger-Verlauf bereinigen, die Apothem aufbewahrt (backups prune). |
| verify | Eine Harness-Adapterinstallation verifizieren. |
| status | Installations-, Verifizierungs- und Drift-Zustand für jeden registrierten Harness melden. |
| diff | Die ausstehenden Konfigurationsänderungen für einen einzelnen Harness in der Vorschau anzeigen. |
| harnesses | Registrierte Harness-Adapter auflisten und inspizieren. |
| profile | Das gemeinsame Apothem-Profil verwalten. |
| migrate-workspace | Einen veralteten Workspace je Harness in das gemeinsame .apothem-Layout migrieren. |
| doctor | Systemdiagnosen für die Apothem-Installation ausführen. |
| completion | Ein per source ladbares Shell-Vervollständigungsskript ausgeben (bash, zsh, fish, powershell). |
JSON-Ausgabevertrag
Jeder Befehl außer completion (der ein Shell-Skript ausgibt) akzeptiert
--json (Kurzform für --format json) und schreibt dann genau ein
JSON-Dokument nach stdout. Jedes Dokument beginnt mit einem
schema_version-Schlüssel auf oberster Ebene, einer Ganzzahl, die derzeit 1
ist:
{"schema_version": 1, "status": "success", "command": "verify", "...": "..."}- Stabilität. Innerhalb einer
schema_versionsind Änderungen additiv: Ein neuer Schlüssel kann hinzukommen, aber kein Schlüssel wird umbenannt oder entfernt, und kein Wert ändert seinen Typ. Alles andere erhöhtschema_version. - Versionierte Artefakte.
profile show --jsongibt das Profil selbst aus, daher ist seineschema_versiondie Version des Profilschemas (derzeit ebenfalls1). - Eine Ausnahme.
harnesses list --jsongibt ein JSON-Array aus (ein Objekt je Harness), wie es das schon immer getan hat, und hat daher keinen Schlüssel auf oberster Ebene, der die Version tragen könnte. Es in ein Objekt zu verpacken, würde bestehende Parser brechen; bis eine Versionserhöhung das tut, behandeln Sie seine Form alsschema_version1. - Fehler. Erwartete Fehlschläge verwenden dieselbe Dokumentform mit
"status": "error"und einemerror-Objekt, dascode,field,reasonundfixträgt.
Exit-Codes
Jeder Befehl verwendet dieselbe kleine Menge an Exit-Codes; jede Seite listet diejenigen auf, die der Befehl zurückgeben kann.
| Code | Bedeutung |
|---|---|
| 0 | Erfolg |
| 1 | Erwarteter Fehlschlag: ein Validierungs-, Profil-, Harness-, Projekt- oder Adapterfehler |
| 2 | Teilergebnis: Ein Batch hat vor einem Fehlschlag etwas geschrieben oder entfernt (nur die Befehle, deren Seite ihn auflistet) |
| 64 | Verwendungsfehler: eine unbekannte Option oder ein unbekannter Befehl, eine fehlende Pflichtoption oder ein ungültiger Optionswert |
Ein Verwendungsfehler berührt niemals das Dateisystem. Unter --json (oder
--format json) gibt er statt des reinen Verwendungstexts ein einziges
Fehlerdokument mit "code": "cli.usage" aus, sodass Automatisierung ein falsch
geschriebenes Flag von einem teilweisen Schreibvorgang unterscheiden kann.
Für Slash-Befehle und die übergeordnete CLI-Übersicht siehe die Referenzseiten CLI-Übersicht und Slash-Befehle.
Plan-Disziplin — Projektlokaler, flüchtiger Arbeitsspeicher
Verwalten Sie projektlokalen, flüchtigen Arbeitsspeicher in .apothem/plans/ (ein Legacy-.plans/-Baum wird per apothem migrate-workspace aktualisiert) mit Frontmatter-Schema, Lebenszyklus-Übergängen, Promotion zu ADRs und Durchsetzung über Hooks und Validatoren.
quickstart
CLI-Referenz für den geführten Erstlauf-Befehl apothem quickstart.