Memulai: dari nol ke harness yang berfungsi
Panduan lengkap dari mesin kosong hingga konfigurasi harness yang dimaterialisasikan dan terverifikasi.
Tutorial ini memandu Anda melalui seluruh penyiapan Apothem pertama Anda. Anda mulai tanpa apa pun terpasang dan berakhir dengan konfigurasi harness nyata — dihasilkan dari profil yang Anda tulis, terverifikasi, dan dikonfirmasi berfungsi. Perkirakan sekitar lima belas menit. Setiap perintah di bawah ini nyata dan dapat disalin-tempel.
Sudah punya penyiapan?
Jika Anda hanya ingin referensi ringkas tentang empat perintah utama, lihat Alur kerja inti. Halaman ini adalah panduan terpandu dari nol hingga eksekusi pertama.
Pada akhirnya Anda akan memiliki:
- Apothem yang dipasang dari pemasang skrip.
- Profil bersama yang mengarahkan setiap harness, telah disunting.
- Konfigurasi native satu harness, dimaterialisasikan.
- Konfigurasi itu terverifikasi dan eksekusi pertama yang berfungsi dikonfirmasi.
Sepanjang tutorial kita akan menggunakan Claude Code sebagai contoh harness, karena itu bawaan pemasang. Langkah yang sama berlaku untuk harness yang didukung mana pun: ganti namanya saat Anda sampai ke daftar harness.
Apa yang Anda butuhkan lebih dulu
- Shell mirip Unix (macOS, Linux, atau WSL). Pemasang PowerShell mencakup Windows;
tutorial ini menunjukkan jalur
bash. - Python 3.10 atau lebih baru di
PATHAnda. Periksa denganpython3 --version. - Dua pustaka runtime yang diimpor mesin dari interpreter Anda:
clickdanrich. Sisa tumpukan (pyyaml,jsonschema) sudah disertakan (vendored) di dalam pohon sumber, jadi hanya kedua pustaka ini yang perlu dapat diimpor. Pemasang memeriksanya, menyebutkan yang hilang, dan menawarkan untuk memasang bagian yang hilang itu untuk Anda, sehingga Anda dapat mengonfirmasi dan melanjutkan.
Apothem didistribusikan sebagai pohon kode sumber yang dikemas alih-alih paket
yang diterbitkan: tidak ada langkah pip install. Pemasang mengkloning pohon dan
menjalankan mesin langsung darinya.
Langkah 1 — Pasang Apothem
Jalankan pemasang jaringan:
curl -fsSL https://apothem.ahmedgad.com/install.sh | bashPemasang melakukan langkah-langkah ini:
- Pemeriksaan prasyarat. Pemasang menemukan interpreter Python 3.10+ yang nyata dan memastikan kedua pustaka runtime (
clickdanrich) dapat diimpor. Jika salah satu hilang, ia menyebutnya dan menawarkan untuk memasangnya untuk Anda — atau setelAPOTHEM_AUTO_INSTALL_DEPS=1untuk memasang tanpa bertanya. - Penempatan kode sumber. Pohon yang dikemas dikloning ke
~/.apothem(timpa dengan variabel lingkunganAPOTHEM_HOME). Eksekusi ulang memperbarui klon yang ada alih-alih menggandakannya. - Inisialisasi profil. Jika Anda belum punya profil, pemasang menyalin
profil contoh ke
~/.config/apothem/profile.yaml, lalu berhenti dan meminta Anda menyuntingnya sebelum melanjutkan. Ini disengaja: contoh menggunakan data identitas placeholder, dan Anda sebaiknya menjadikannya milik Anda sebelum menulis konfigurasi lingkungan apa pun. Kita akan melakukannya di Langkah 2.
Anda dapat mengarahkan instalasi dengan variabel lingkungan. Yang paling mungkin Anda gunakan:
# Install a different harness as the default, and point at a project profile.
APOTHEM_HARNESS=cursor \
APOTHEM_PROFILE="$HOME/.config/apothem/profile.yaml" \
curl -fsSL https://apothem.ahmedgad.com/install.sh | bashVariabel lain yang dikenali adalah APOTHEM_REPO dan APOTHEM_REF (remote mana
yang dikloning dan ref git mana yang diunduh; tanpa diset ia menyelesaikan dan
memverifikasi tag versi bertanda tangan terbaru, set sebuah tag untuk menyematkan
atau main untuk branch yang bergerak), APOTHEM_ALLOW_UNVERIFIED=1 (menurunkan
kegagalan verifikasi tanda tangan tag menjadi peringatan), APOTHEM_SOURCE
(menggunakan checkout lokal yang ada alih-alih mengkloning), dan
APOTHEM_SKIP_VERIFY=1 (melewati verifikasi pasca-instalasi, yang justru ingin
kita jalankan, jadi biarkan tidak diset).
Saat pemasang menyelesaikan eksekusi penuh, ia mencetak banner yang menunjukkan
cara memanggil mesin. Ia menempatkan shim apothem di PATH Anda (POSIX:
$HOME/.local/bin; Windows: %LOCALAPPDATA%\Microsoft\WindowsApps), jadi
setelah direktori itu ada di PATH Anda menjalankan mesin secara langsung:
apothem <command>Jika shim tidak dapat ditempatkan — atau direktorinya belum ada di PATH —
banner mencetak fallback mandiri yang tidak memerlukan shim:
PYTHONPATH="$HOME/.apothem/src" python3 -m apothem <command>Sisa tutorial ini menulis apothem <command>; jika Anda memakai bentuk
fallback, tambahkan prefiks persis yang dicetak banner pemasang Anda di depan.
Langkah 2 — Jadikan profil milik Anda
Profil bersama di ~/.config/apothem/profile.yaml adalah satu-satunya sumber
kebenaran. Setiap adapter harness membacanya dan menurunkan konfigurasi native
harness itu darinya. Sunting sekali dan setiap harness yang Anda pasang
tetap konsisten.
Buka di editor mesin, atau editor teks apa pun:
apothem profile editProfil minimal yang valid tampak seperti ini:
identity:
name: "Example User"
preferences:
style: "concise"
rules:
- "Validate external input before writing files."Ganti name placeholder dengan milik Anda, dan tambahkan aturan apa pun yang Anda
ingin diterapkan setiap harness. Pertahankan nilai contoh yang fiktif: profil
ini dirancang agar aman dibagikan.
Pastikan mesin membaca ulang suntingan Anda tanpa masalah:
apothem profile show --jsonJika YAML cacat, di sinilah Anda akan melihatnya: perbaiki dan jalankan ulang sebelum melanjutkan.
Langkah 3 — Materialisasikan konfigurasi harness
Pemasang sudah mematerialisasikan harness bawaan selama Langkah 1. Untuk
melakukannya secara eksplisit — atau untuk mematerialisasikan harness kedua —
jalankan install:
apothem install --harness claude-codeIni membaca profil Anda dan menulis konfigurasi native Claude Code. Untuk melihat setiap harness yang dapat Anda tuju:
apothem harnesses listBeberapa harness bercakupan proyek alih-alih bercakupan pengguna, dan itu
membutuhkan path --project agar adapter tahu ke mana harus menulis:
apothem install --harness cursor --project .Langkah 4 — Verifikasi dan konfirmasi eksekusi pertama
Materialisasi hanyalah separuh cerita. Sekarang konfirmasikan bahwa konfigurasi diterapkan dengan benar:
apothem verify --harness claude-codeverify memeriksa bahwa berkas konfigurasi harness yang diharapkan ada dan
cocok dengan apa yang dideklarasikan profil. Eksekusi yang bersih berarti
materialisasi berhasil.
Untuk pemeriksaan kesehatan seluruh mesin pada setiap adapter terdaftar, jalankan:
apothem doctordoctor melaporkan status instalasi setiap adapter dan keluar dengan kode
bukan-nol jika ada adapter terdaftar yang melaporkan dirinya tidak terpasang:
gerbang yang berguna dalam skrip penyiapan.
Eksekusi pertama Anda. Buka harness yang baru saja Anda konfigurasikan — Claude Code, dalam contoh kita — dan mulai sesi di proyek mana pun. Aturan dan preferensi yang Anda tulis ke profil sudah menjadi bagian dari perilaku alat itu. Itulah eksekusi pertama yang berfungsi: profil yang Anda sunting di Langkah 2 sedang membentuk sesi nyata.
Apa yang Anda bangun
Mulai dari mesin kosong, Anda memasang Apothem, menulis profil bersama,
mematerialisasikan konfigurasi native satu harness darinya, memverifikasi
hasilnya, dan mengonfirmasikannya berfungsi. Profil adalah artefak yang bertahan:
ubah sekali dan jalankan ulang apothem update --harness <name> untuk mendorong
perubahan ke harness mana pun.
Ke mana selanjutnya
- Tambahkan alat lain. Daftar harness mencakup setiap
platform yang didukung dan nama adapternya. Ulangi Langkah 3 dengan
--harnessbaru. - Selami satu tugas lebih dalam. Panduan praktis adalah resep yang berfokus pada tugas untuk menulis aturan, membuat rencana, dan menjalankan gerbang kesesuaian.
- Cari detail konkret. Referensi mendokumentasikan setiap adapter, skema profil, dan seluruh permukaan CLI.
- Rencanakan pekerjaan yang bertahan melampaui satu sesi.
Perencanaan yang dapat dilanjutkan
menjelaskan cara Apothem mengeksternalkan pekerjaan jangka-panjang ke suite
.apothem/plans/lokal-proyek sehingga sesi baru di mesin mana pun melanjutkannya di tempat.
Langkah Berikutnya yang Disarankan
Jalankan apothem doctor untuk memeriksa penyiapan Anda — ia melaporkan
keadaan setiap adapter terdaftar, sehingga harness yang baru Anda pasang tampil
sebagai sehat sementara sisanya tampil sebagai belum-terpasang — sebelum Anda
lanjut menambah lebih banyak harness.