quickstart

Eksekusi pertama terpandu: memastikan profil ada, mempratinjau penulisan, lalu memasang.

Ringkasan

apothem quickstart [--harness NAME|all] [--project PATH] [--profile PATH]
                   [--yes] [--quiet|-q] [--verbose|-v]
                   [--format plain|json] [--json] [--no-color]

quickstart adalah satu-satunya titik masuk terpandu bagi operator baru. Dalam satu alur linear, perintah ini: (1) memastikan profil bersama ada — membuat profil awal disertai dorongan untuk mempersonalisasinya jika tidak ditemukan; (2) mempratinjau berkas konkret yang akan ditulis oleh harness terpilih, dikelompokkan menurut root proyek versus direktori home Anda; (3) meminta konfirmasi; (4) memasang dengan keluaran catatan kemampuan yang terkelompok dan bebas derau; dan (5) mencetak perintah lanjutan yang direkomendasikan.

Perintah ini menyusun blok pembangun yang sama dengan yang digunakan perintah install — perintah ini tidak mengimplementasikannya ulang. --project default-nya direktori saat ini. --harness tidak memiliki default: ketika dihilangkan, quickstart menanyakan harness mana yang akan dipasang, sehingga eksekusi pertama menulis konfigurasi satu harness. --harness all memasang setiap harness yang didukung dan selalu merupakan pilihan eksplisit.

Perilaku

Harness — tanpa --harness, eksekusi interaktif mencantumkan nama-nama yang didukung (ditambah all) dan meminta satu nama sebelum apa pun ditulis. Eksekusi yang tidak dapat bertanya — --yes, --format json, atau tanpa terminal — berhenti dengan galat penggunaan yang menyebutkan opsi --harness, dan tidak menulis apa pun.
Profil — jika jalur profil yang di-resolve tidak memiliki berkas, quickstart menawarkan untuk membuat profil awal (membuatnya otomatis di bawah --yes, shell non-interaktif, atau --format json) dan menyebutkan bidang identitas placeholder yang perlu dipersonalisasi.
Pratinjau + konfirmasi — untuk --harness all, target dicantumkan di bawah dua judul (root proyek versus direktori home Anda), dan eksekusi interaktif meminta konfirmasi sebelum menulis di luar proyek. Satu harness bernama dipasang tanpa pratinjau atau prompt. --yes, shell non-interaktif, dan --format json melanjutkan tanpa meminta konfirmasi. Menolak pratinjau --harness all membatalkan proses sebelum penulisan instalasi; profil awal yang dibuat pada langkah 1 tetap dipertahankan.
Pemasangan — kemampuan yang tidak didukung secara native oleh sebuah harness diringkas sebagai satu catatan terkelompok per harness (berikan --verbose untuk detail per kemampuan); himpunan lengkapnya selalu ada di larik warnings --format json.
Langkah berikutnya — keluaran terminal menyebutkan perintah lanjutan (apothem verify …, apothem doctor).

Opsi

Opsi	Deskripsi
`--harness NAME`	Adapter harness yang akan dipasang, atau `all` untuk himpunan selingkup registri. Tanpa default: eksekusi interaktif menanyakannya; eksekusi non-interaktif wajib memberikannya.
`--profile PATH`	Jalur ke YAML profil bersama. Default-nya `~/.config/apothem/profile.yaml`.
`--project PATH`	Root proyek untuk harness berlingkup-proyek. Default-nya direktori saat ini.
`--yes`	Menjalankan urutan terpandu lengkap secara non-interaktif (melewati setiap prompt).
`--quiet`, `-q`	Menekan keluaran informatif; hanya galat yang dipancarkan.
`--verbose`, `-v`	Mencetak alasan setiap kemampuan yang tidak diproyeksikan alih-alih catatan terkelompok.
`--format plain\|json`	Format keluaran (default: `plain`).
`--json`	Singkatan untuk `--format json`.
`--no-color`	Menonaktifkan kode warna ANSI dalam keluaran.
`-h`, `--help`	Menampilkan bantuan dan keluar.

Keluaran JSON

--format json memancarkan satu dokumen yang meringkas setiap langkah terpandu:

{
  "schema_version": 1,
  "status": "success",
  "command": "quickstart",
  "profile_path": "C:\\Users\\Example\\.config\\apothem\\profile.yaml",
  "steps": [
    {"step": "profile", "outcome": "created", "path": "…", "placeholder_identity": ["name", "email", "github"]},
    {"step": "install", "status": "success", "harness": "all", "files_written": ["…"], "warnings": [], "results": []},
    {"step": "recommend", "next": ["apothem verify --harness all --project .", "apothem doctor"]}
  ],
  "recommended_next": ["apothem verify --harness all --project .", "apothem doctor"]
}

Contoh

apothem quickstart                                  # asks which harness
apothem quickstart --harness claude-code --yes
apothem quickstart --harness all --project . --yes  # every harness, explicitly
apothem quickstart --harness claude-code --json

Kode keluar

Kode	Arti
0	Eksekusi terpandu selesai
1	Galat validasi, profil, harness, proyek, atau adapter yang diharapkan
2	Materialisasi batch parsial setelah setidaknya satu penulisan
64	Galat 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

apothem install — mematerialisasi sebuah harness dari profil bersama
apothem verify — memastikan sebuah pemasangan aktif
apothem doctor — kesehatan lingkungan dan pemasangan
Memulai — panduan pemasangan lengkap

quickstart

RingkasanCopy Anchor Link

PerilakuCopy Anchor Link

OpsiCopy Anchor Link

Keluaran JSONCopy Anchor Link

ContohCopy Anchor Link

Kode keluarCopy Anchor Link

Lihat jugaCopy Anchor Link