Dokumentasi Pi
Pi adalah framework coding Agent minimal untuk terminal. Intinya tetap kecil dan dapat diperluas dengan ekstensi TypeScript, Skills, Prompt Templates, Themes, serta Pi Packages.
Mulai cepat
Instal Pi dengan npm:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts menonaktifkan skrip siklus hidup dependensi selama pemasangan. Pi tidak memerlukan skrip pemasangan untuk instalasi npm biasa.
Di Linux atau macOS, Anda juga dapat menggunakan pemasang:
curl -fsSL https://pi.dev/install.sh | shUntuk menghapus Pi itu sendiri yang dipasang melalui pemasang curl atau npm, gunakan npm:
npm uninstall -g @earendil-works/pi-coding-agentUntuk pemasangan dengan pnpm, Yarn, atau Bun, gunakan perintah penghapusan global yang sesuai: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent, atau bun uninstall -g @earendil-works/pi-coding-agent.
Kemudian jalankan di direktori proyek:
piAutentikasi dengan /login untuk Provider berlangganan, atau tetapkan API key seperti ANTHROPIC_API_KEY sebelum memulai pi.
Untuk alur lengkap saat pertama kali menjalankan Pi, lihat Quickstart.
Mulai dari sini
- Quickstart - instal, autentikasi, dan mulai sesi pertama.
- Using Pi - mode interaktif, slash commands, context files, dan referensi CLI.
- Providers - pengaturan langganan dan API key untuk Provider bawaan.
- llama.cpp - jalankan router lokal dan kelola model dengan
/llama. - Security - kepercayaan proyek, batas sandbox, dan pelaporan kerentanan.
- Containerization - isolasikan pi dalam sandbox dengan Gondolin, Docker, atau OpenShell.
- Settings - pengaturan global dan proyek.
- Keybindings - pintasan default dan keybinding khusus.
- Sessions - pengelolaan sesi, percabangan, dan navigasi pohon.
- Compaction - pemadatan konteks dan ringkasan branch.
Kustomisasi
- Extensions - modul TypeScript untuk tool, perintah, event, dan UI khusus.
- Skills - Agent Skills untuk kemampuan yang dapat digunakan kembali sesuai kebutuhan.
- Prompt templates - prompt yang dapat digunakan kembali dan diperluas dari slash commands.
- Themes - tema terminal bawaan dan khusus.
- Pi packages - paketkan dan bagikan ekstensi, Skills, prompt, dan tema.
- Custom models - tambahkan entri model untuk API Provider yang didukung.
- Custom providers - implementasikan API dan alur OAuth khusus.
Penggunaan terprogram
- SDK - sematkan pi dalam aplikasi Node.js.
- RPC mode - integrasikan melalui stdin/stdout JSONL.
- JSON event stream mode - print mode dengan event terstruktur.
- TUI components - buat UI terminal khusus untuk ekstensi.
Referensi
- Environment variables - konfigurasi proses Pi dan metadata sesi yang tersedia bagi tool bash.
- Session format - format file sesi JSONL, jenis entri, dan API SessionManager.
Penyiapan platform
Pengembangan
- Development - penyiapan lokal, struktur proyek, dan debugging.