Referensi CLI

Antarmuka baris perintah apothem mengelola konfigurasi adapter harness dari profil bersama. Setiap halaman di bawah mendokumentasikan satu subperintah: sinopsisnya, opsinya, perilakunya, dan kode keluarnya.

Masing-masing dari install, update, dan uninstall juga menerima alias bentuk-kontinu (installing, updating, uninstalling) yang identik dalam flag dan perilaku dengan perintah dasarnya. Memperbarui dan mencopot pemasangan melalui kanal pemasangan — plugin Claude Code, npx, dan skrip pemasang sekali-jalan — didokumentasikan dalam panduan pemasangan Memperbarui dan Mencopot pemasangan, bukan oleh alias itu sendiri.

PerintahCopy Anchor Link

Kontrak keluaran JSONCopy Anchor Link

Setiap perintah kecuali completion (yang memancarkan skrip shell) menerima --json (singkatan untuk --format json) lalu menulis tepat satu dokumen JSON ke stdout. Setiap dokumen diawali dengan kunci tingkat atas schema_version, sebuah bilangan bulat yang saat ini bernilai 1:

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

• Stabilitas. Dalam satu schema_version, perubahan bersifat aditif: kunci baru dapat muncul, tetapi tidak ada kunci yang diganti namanya atau dihapus dan tidak ada nilai yang berubah tipe. Perubahan lain apa pun menaikkan schema_version.
• Artefak berversi. profile show --json memancarkan profil itu sendiri, sehingga schema_version-nya adalah versi skema profil (juga 1 saat ini).
• Satu pengecualian. harnesses list --json memancarkan larik JSON (satu objek per harness), seperti yang selalu dilakukannya, sehingga ia tidak memiliki kunci tingkat atas untuk membawa versi. Membungkusnya dalam sebuah objek akan merusak parser yang ada; sampai sebuah kenaikan versi melakukannya, perlakukan bentuknya sebagai schema_version 1.
• Galat. Kegagalan yang diharapkan menggunakan bentuk dokumen yang sama dengan "status": "error" dan objek error yang membawa code, field, reason, dan fix.

Kode keluarCopy Anchor Link

Setiap perintah menggunakan kumpulan kecil kode keluar yang sama; setiap halaman mencantumkan kode yang dapat dikembalikannya.

Galat penggunaan tidak pernah menyentuh sistem berkas. Di bawah --json (atau --format json) galat ini mencetak satu dokumen galat dengan "code": "cli.usage" alih-alih teks penggunaan biasa, sehingga otomatisasi dapat membedakan flag yang salah ketik dari penulisan parsial.

Untuk perintah slash dan ikhtisar CLI tingkat lebih tinggi, lihat halaman referensi Ikhtisar CLI dan Perintah slash.