Skip to content
Apothem
Referensi CLI

doctor

Referensi CLI untuk perintah apothem doctor.

Memeriksa kesehatan apa yang terpasang. Sementara apothem verify memeriksa harness yang Anda pilih, doctor memeriksa setiap harness yang terpasang dan profil bersama dalam satu kali jalan.

Ringkasan

apothem doctor [--project PATH] [--quiet|-q] [--verbose|-v]
               [--format plain|json] [--json] [--no-color]

Apa yang diperiksa

  • Profil bersama. Profil yang ada divalidasi terhadap skema yang dipaket; profil yang salah bentuk gagal dengan kode diagnostiknya. Profil yang tidak ada dilaporkan, bukan digagalkan (install membuatnya).
  • Hanya harness yang terpasang. Harness yang tidak terpasang dilaporkan sebagai not_installed dan bukan merupakan kegagalan, sehingga mesin dengan satu harness yang sehat tetap lolos. Harness berlingkup-proyek diperiksa ketika --project menyebutkan root-nya; tanpa opsi itu, harness tersebut dilaporkan sebagai needs_project.
  • Verifikasi. Setiap harness yang terpasang harus lolos pemeriksaan yang sama dengan verify.
  • Runtime hook. Untuk setiap harness yang terverifikasi, doctor membaca berkas yang ditulis oleh pemasangan terbarunya, menemukan perintah hook yang didaftarkan Apothem di sana, lalu memulai setiap interpreter dan skrip hook satu kali dengan payload no-op (argumen yang terdaftar ditambah --help, {} pada stdin, direktori kerja sementara, dan PYTHONPATH dihapus). Tidak ada yang ditulis. Interpreter yang hilang, skrip yang hilang, atau crash pada saat impor menggagalkan pemeriksaan.

Setiap pemeriksaan yang gagal menyebutkan perbaikannya. Keluar dengan 0 ketika tidak ada pemeriksaan yang gagal dan dengan 1 jika ada yang gagal.

Keluaran JSON

--json mempertahankan bidang-bidang sebelumnya (version, python, platform, profile_path, profile_exists, profile_valid, harnesses, all_ok, dan profile_error ketika profil tidak valid) dan menambahkan:

  • profile_error_code — kode diagnostik profil, ketika profil tidak valid.
  • project — root --project yang telah di-resolve, atau null.
  • harnesses[].status — ok, not_installed, needs_project, verify_failed, hook_failed, atau error; ditambah verified dan hooks ({"probed": N, "failed": [...]}, atau null ketika tidak ada catatan pemasangan).
  • checks — satu catatan per pemeriksaan: code (misalnya harness.verify_failed, hook.start_failed, ledger.unreadable, atau kode profile.*), status (pass, fail, atau info), harness, message, dan fix.
{
  "schema_version": 1,
  "all_ok": false,
  "checks": [
    {
      "code": "hook.start_failed",
      "status": "fail",
      "harness": "claude-code",
      "message": "claude-code: a registered hook command cannot start: …",
      "fix": "Check that the interpreter in the hook command exists and runs, then …"
    }
  ]
}

Opsi

OpsiDeskripsi
--project PATHRoot proyek untuk harness berlingkup-proyek; tanpa opsi ini, harness tersebut dilaporkan sebagai needs_project.
--quiet, -qMenekan keluaran informatif; hanya galat yang dipancarkan.
--verbose, -vDiterima demi konsistensi dengan perintah lain; perintah ini tidak mencetak keluaran tambahan.
--format plain|jsonFormat keluaran (default: plain).
--jsonSingkatan untuk --format json.
--no-colorMenonaktifkan kode warna ANSI dalam keluaran.
-h, --helpMenampilkan bantuan dan keluar.

Contoh

apothem doctor
apothem doctor --project .
apothem doctor --json

Format default plain mencetak diagnostik yang dapat dibaca manusia; --json (setara dengan --format json) memancarkan dokumen yang dapat dibaca mesin pada stdout, cocok untuk disalurkan ke perkakas lain.

Kode keluar

KodeArti
0Semua pemeriksaan lulus (juga ketika belum ada harness yang terpasang)
1Harness yang terpasang tidak lolos verifikasi, perintah hook yang terdaftar tidak dapat dimulai, adapter tidak dapat dimuat atau diperiksa, atau profil yang ada gagal validasi skema
64Galat penggunaan: opsi atau perintah yang tidak dikenal, atau nilai opsi yang hilang atau tidak valid. Di bawah --json, galat berupa amplop JSON dengan kode cli.usage.

Lihat juga

On this page