Pi Belgeleri
Pi, terminalde çalışan minimal bir coding Agent framework'üdür. Çekirdek küçük kalır; TypeScript uzantıları, Skills, Prompt Templates, Themes ve Pi Packages ile genişletilebilir.
Hızlı başlangıç
Pi'yi npm ile yükleyin:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts, yükleme sırasında bağımlılık yaşam döngüsü betiklerini devre dışı bırakır. Normal npm kurulumlarında Pi için kurulum betikleri gerekmez.
Linux veya macOS'ta yükleyiciyi de kullanabilirsiniz:
curl -fsSL https://pi.dev/install.sh | shcurl yükleyicisi veya npm ile kurulan Pi'nin kendisini kaldırmak için npm kullanın:
npm uninstall -g @earendil-works/pi-coding-agentpnpm, Yarn veya Bun ile yapılan kurulumlarda uygun genel kaldırma komutunu kullanın: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent ya da bun uninstall -g @earendil-works/pi-coding-agent.
Ardından bir proje dizininde çalıştırın:
piAbonelik Provider'ları için /login ile kimlik doğrulayın veya pi'yi başlatmadan önce ANTHROPIC_API_KEY gibi bir API key ayarlayın.
İlk çalıştırmanın tüm akışı için Quickstart sayfasına bakın.
Buradan başlayın
- Quickstart - yükleyin, kimlik doğrulayın ve ilk oturumu başlatın.
- Using Pi - etkileşimli mod, slash commands, context files ve CLI referansı.
- Providers - yerleşik Provider'lar için abonelik ve API key ayarı.
- llama.cpp - yerel bir yönlendirici çalıştırın ve modelleri
/llamaile yönetin. - Security - proje güveni, sandbox sınırları ve güvenlik açığı bildirimi.
- Containerization - Gondolin, Docker veya OpenShell ile pi'yi sandbox içinde izole edin.
- Settings - genel ve proje ayarları.
- Keybindings - varsayılan kısayollar ve özel tuş atamaları.
- Sessions - oturum yönetimi, dallanma ve ağaçta gezinme.
- Compaction - bağlam sıkıştırma ve dal özetleri.
Özelleştirme
- Extensions - araçlar, komutlar, olaylar ve özel UI için TypeScript modülleri.
- Skills - yeniden kullanılabilir, isteğe bağlı yetenekler için Agent Skills.
- Prompt templates - slash commands ile genişleyen yeniden kullanılabilir istemler.
- Themes - yerleşik ve özel terminal temaları.
- Pi packages - uzantıları, Skills'i, istemleri ve temaları paketleyip paylaşın.
- Custom models - desteklenen Provider API'leri için model girdileri ekleyin.
- Custom providers - özel API'leri ve OAuth akışlarını uygulayın.
Programatik kullanım
- SDK - pi'yi Node.js uygulamalarına gömün.
- RPC mode - stdin/stdout JSONL üzerinden entegre edin.
- JSON event stream mode - yapılandırılmış olaylar içeren print mode.
- TUI components - uzantılar için özel terminal UI oluşturun.
Referans
- Environment variables - bash araçlarının kullanabildiği Pi süreç yapılandırması ve oturum meta verileri.
- Session format - JSONL oturum dosyası biçimi, girdi türleri ve SessionManager API.
Platform kurulumu
Geliştirme
- Development - yerel kurulum, proje yapısı ve hata ayıklama.