Mulai cepat
Pasang Apothem, tulis profil, materialisasikan harness pertama Anda, dan verifikasi — tur salin-tempel dengan keluaran yang diharapkan.
Ini adalah jalur cepat dari nol ke konfigurasi harness yang terverifikasi: pasang, tulis profil bersama, materialisasikan konfigurasi native satu alat, konfirmasikan, dan lakukan suntingan pertama Anda. Setiap perintah nyata dan dapat dijalankan dengan salin-tempel, dan setiap langkah menampilkan apa yang dicetak oleh eksekusi yang bersih. Instalasinya sendiri selesai dalam waktu kurang dari dua menit; menyunting profil adalah satu-satunya bagian yang memakan waktu selama yang Anda inginkan.
Pada akhirnya Anda akan memiliki konfigurasi harness yang berfungsi, yang dihasilkan dari profil yang Anda tulis — dan Anda akan mengetahui satu perintah yang mendorong perubahan profil kembali ke satu alat atau ke semuanya.
Ingin versi yang lambat dan bernarasi?
Tutorial memulai menempuh jalur yang sama dengan lebih banyak penjelasan tentang setiap langkah dan alasan langkah itu penting. Halaman ini adalah tur ringkas yang mendahulukan keluaran.
Anda akan menggunakan Claude Code sebagai contoh harness — ini adalah default pemasang. Ganti nama adapter di langkah mana pun untuk menargetkan alat lain; daftar harness memuat setiap nama yang didukung.
1. Pasang Apothem
Apothem dikirim sebagai runtime mandiri — mesin berjalan langsung dari pohon
sumbernya dengan dependensi yang di-vendor. Satu perintah mengambil sumber,
menempatkan mesin, dan mematerialisasikan harness pertama Anda. Pemasang
memverifikasi rilis yang ditandatangani lebih dulu, jadi impor kunci penandatanganan
pemelihara sekali sebelum instalasi pertama dan periksa bahwa sidik jari menunjukkan
5C89 98F9 F241 7204 45D3 F28B 7039 6FED 9C63 4163:
curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import
gpg --fingerprint 70396FED9C634163& "$env:ProgramFiles\Git\bin\bash.exe" -c 'curl -fsSL https://github.com/ahmed-g-gad.gpg | gpg --import && gpg --fingerprint 70396FED9C634163'Lalu jalankan pemasang:
curl -fsSL https://apothem.ahmedgad.com/install.sh | bashirm https://apothem.ahmedgad.com/install.ps1 | iexPemasang memerlukan Python 3.10+ sistem, ditambah git dan gpg untuk bentuk jaringan.
Pemasang memeriksa prasyarat dan menempatkan mesin di bawah ~/.apothem. Ketika
click atau rich tidak ada, pemasang memasang paketnya dengan konfirmasi Anda, atau saat
--yes (-Yes pada PowerShell) atau APOTHEM_AUTO_INSTALL_DEPS=1 diberikan, dan jika
tidak, berhenti dengan perintah pip yang harus dijalankan (lihat
Prasyarat sekilas). Setelah selesai,
pemasang mencetak banner langkah berikutnya; pada POSIX, ketika direktori shim
sudah ada di PATH, banner tampak seperti ini:
Installation complete.
The 'apothem' command is on your PATH.
Recommended first step — the guided setup (profile -> preview -> install):
apothem quickstartEksekusi pertama tanpa profil
Jika Anda belum memiliki profil, pemasang menyalin profil contoh ke
~/.config/apothem/profile.yaml dan terus berjalan: pemasang
mematerialisasikan harness pertama Anda dan memverifikasinya dalam eksekusi
yang sama. Kolom identitas pada contoh tersebut adalah placeholder, sehingga
instalasi mencetak sebuah catatan. Jadikan profil itu milik Anda di Langkah 2,
lalu terapkan dengan apothem update --harness <name> seperti di Langkah 5.
Perintah `apothem`
Pemasang menulis shim apothem ke dalam $HOME/.local/bin (POSIX) atau
%LOCALAPPDATA%\Microsoft\WindowsApps (Windows) dan tidak pernah menyunting
PATH Anda. Setelah direktori itu ada di PATH, Anda menjalankan mesin secara
langsung sebagai apothem <command>. Jika direktori itu belum ada di PATH,
banner mencetak fallback mandiri —
PYTHONPATH="$HOME/.apothem/src" python3 -m apothem <command> — yang tidak
memerlukan shim; tambahkan prefiks persis yang dicetak banner Anda di depan
setiap perintah.
Panduan instalasi mencakup jalur instalasi lainnya — plugin
Claude Code (/plugin marketplace add ahmed-g-gad/apothem lalu
/plugin install apothem@apothem); ekstensi keluarga VS Code dan ekstensi
native-alat lainnya; serta bentuk npx sesuai permintaan
(npx @ahmed-g-gad/apothem <command>) — bersama opsi variabel lingkungan.
2. Buat profil bersama
apothem profile init menulis profil valid-skema terkecil ke
~/.config/apothem/profile.yaml. Jika sebuah profil sudah ada di sana, seperti
ketika pemasang pada Langkah 1 menyalin contoh, init berhenti dengan galat dan
membiarkan berkas tidak berubah; berikan --force untuk menimpanya, atau
pertahankan berkas itu dan sunting seperti ditunjukkan di bawah. Berikan
--profile PATH saat Anda menyimpan profil khusus proyek atau khusus CI di
tempat lain.
apothem profile init
apothem profile show --jsonKerangka ini menggunakan data identitas placeholder palsu dan aman untuk disunting
sebelum Anda memasang keluaran harness apa pun. show --json membacanya kembali
dan melaporkan profil yang tervalidasi dengan setiap nilai default terisi, diawali
dengan schema_version. Perintah ini mencetaknya dalam satu baris; di sini
ditampilkan secara diperluas:
{
"schema_version": 1,
"identity": {
"name": "Example User",
"role": "senior software engineer",
"email": "[email protected]",
"github": "example-user"
},
"preferences": {
"language": "python",
"style": "concise"
},
"rules": [],
"seriousness": "PERSONAL_USE",
"enforcement": {
"sprints": false,
"agent_teams": false,
"multitasking": false,
"continuous_execution": false,
"learning_loop": false
},
"mcp_servers": {},
"agent_mcp_servers": {},
"harnesses": {},
"exclude_harnesses": [],
"workspace": {
"directory_name": ".apothem",
"scope": "project-local"
}
}Di sini pula suntingan yang cacat muncul — jika YAML tidak valid, show
melaporkannya di sini, sebelum konfigurasi harness apa pun ditulis. Jadikan profil
milik Anda dengan apothem profile edit (membukanya di editor Anda) atau setel
satu kunci di tempat:
apothem profile set identity.name "Your Name"3. Pasang adapter harness
Materialisasikan adapter untuk harness utama Anda. Ini membaca profil Anda dan menulis konfigurasi native alat tersebut:
apothem install --harness claude-code✓ Installed claude-code -> /home/you/.claude/settings.jsonAdapter bercakupan proyek menulis berkas aturannya di dalam sebuah proyek,
sehingga memerlukan --project PATH; tujuh di antaranya juga menulis skill dan
aturan bersama ke folder di direktori home Anda, dan --project tidak mengubah
lokasi tujuan berkas-berkas itu. Pratinjau instalasi apa pun tanpa menulis
berkas dengan --dry-run:
apothem install --harness cursor --project . --dry-run
apothem install --harness cursor --project .Pasang seluruh set yang didukung registri sekaligus dengan --harness all.
Karena pilihan itu menulis berkas bercakupan proyek maupun berkas bercakupan
pengguna, perintah mencetak target konkret yang dikelompokkan menurut lokasi. Di
terminal interaktif, perintah meminta konfirmasi sebelum menulis di luar root
proyek. Eksekusi tanpa terminal, eksekusi yang diberi --yes, atau eksekusi
dengan --format json menulis tanpa bertanya; --dry-run tidak menulis apa
pun. Jalankan seluruh set dengan:
apothem install --harness all --project .Lihat daftar harness lengkap untuk setiap nama yang didukung, dan referensi install untuk set opsi lengkap.
4. Verifikasi
Materialisasi hanyalah separuh pekerjaan — verify memastikan berkas konfigurasi
yang diharapkan harness sudah terpasang dan valid:
apothem verify --harness claude-code✓ claude-code is verified at /home/you/.claude/settings.jsonverify keluar dengan kode bukan-nol jika target terkelola hilang, berkas
terkelola kosong, atau konfigurasi JSON atau YAML tidak dapat diurai. Tambahkan
--profile PATH untuk juga gagal ketika berkas yang terpasang berbeda dari
profil tersebut, sehingga verify berfungsi sebagai pemeriksaan penyimpangan;
tanpanya, konfigurasi yang usang tetap lolos verifikasi. Kode keluar bukan-nol
memungkinkan verify berfungsi sebagai gerbang dalam skrip penyiapan. Untuk
pemeriksaan kesehatan seluruh mesin di setiap adapter terdaftar, jalankan:
apothem doctordoctor memeriksa setiap harness yang terpasang: harness itu harus lolos
verifikasi, dan setiap perintah hook yang didaftarkan oleh instalasinya harus
dapat dimulai. Harness yang belum Anda pasang tercantum tetapi tidak dihitung
sebagai kegagalan, sehingga doctor keluar dengan kode 0 ketika tidak ada
pemeriksaan yang gagal, bahkan jika hanya satu harness yang terpasang.
5. Eksekusi pertama Anda
Buka harness yang baru saja Anda konfigurasikan — Claude Code, dalam contoh ini — dan mulai sesi di proyek mana pun. Profil yang Anda siapkan di Langkah 2 kini menjadi bagian dari perilaku alat itu. Itulah eksekusi pertama yang berfungsi: satu profil, membentuk sesi nyata.
Saat Anda mengubah profil nanti, terapkan ulang tanpa memasang ulang:
apothem update --harness claude-codeSebutkan adapter lain untuk menerapkan ulang profil ke alat itu (tambahkan
--project PATH untuk adapter bercakupan proyek), atau berikan
--harness all --project . untuk menerapkannya ulang ke setiap harness yang
didukung.
Langkah berikutnya
- Tambahkan lebih banyak harness — ulangi Langkah 3 untuk setiap alat.
- Tulis aturan pertama Anda — unit yang diwarisi setiap harness.
- Tulis sebuah rencana — arahkan seluruh misi melalui pipeline rencana yang deterministik.
- Referensi CLI — setiap perintah, flag, dan kode keluar.
Instalasi
Ikhtisar instalasi Apothem — delapan kanal instalasi, masing-masing dengan prasyaratnya, satu perintah siap-salin, dan langkah verifikasi: plugin Claude Code, shim npm, pemasang satu langkah, ekstensi keluarga VS Code, tiga ekstensi bootstrap baris perintah, dan mesin langsung.
Konsep
Glosarium yang mendefinisikan profil bersama, adapter harness, aturan, hook, gerbang konformitas, skill, dan pekerja terdelegasi di Apothem.