Pi Belgeler
Pi minimum terminal kodlama donanımıdır. TypeScript uzantılar, beceriler, prompt templates, temalar ve pi paketleri aracılığıyla genişletilirken özünde küçük kalacak şekilde tasarlanmıştır.
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ü komut dosyalarını devre dışı bırakır. Pi normal npm kurulumları için kurulum komut dosyalarına ihtiyaç duymaz.
Linux veya macOS'ta yükleyiciyi de kullanabilirsiniz:
curl -fsSL https://pi.dev/install.sh | shPi'nin kendisini kaldırmak için curl ve npm kurulumları için npm kullanın:
npm uninstall -g @earendil-works/pi-coding-agentpnpm, Yarn veya Bun yüklemeleri için eşleşen genel kaldırma komutunu kullanın: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent veya bun uninstall -g @earendil-works/pi-coding-agent.
Daha sonra bunu bir proje dizininde çalıştırın:
pisubscription providers için /login ile kimlik doğrulaması yapın veya pi'yi başlatmadan önce ANTHROPIC_API_KEY gibi bir API key ayarlayın.
İlk çalıştırma akışının tamamı için bkz. Quickstart.
Buradan başlayın
- Quickstart - ilk oturumu yükleyin, doğrulayın ve çalıştırın.
- Using Pi - etkileşimli mod, slash commands, context files ve CLI referansı.
- Providers - yerleşik sağlayıcılar için abonelik ve API tuş kurulumu.
- 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çığı raporlaması.
- Containerization - sandbox pi ile Gondolin, Docker veya OpenShell.
- 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 - context compaction ve branch summarization.
Özelleştirme
- Extensions - TypeScript araçlar, komutlar, etkinlikler ve özel kullanıcı arayüzü için modüller.
- Skills - Yeniden kullanılabilir isteğe bağlı özellikler için Aracı Skills.
- Prompt templates - slash commands'den genişleyen yeniden kullanılabilir istemler.
- Themes - yerleşik ve özel terminal themes.
- Pi packages - Uzantıları, becerileri, istemleri ve temaları paketleyin ve paylaşın.
- Custom models - desteklenen sağlayıcı API'ler için model girişleri ekleyin.
- Custom providers - özel API ve OAuth akışlarını uygulayın.
Programatik kullanım
- SDK - Pi'yi Node.js uygulamalarına yerleştirin.
- RPC mode - stdin/stdout JSONL üzerinden integral alın.
- JSON event stream mode - yapılandırılmış olaylarla yazdırma modu.
- TUI components - uzantılar için özel terminal kullanıcı arayüzü oluşturun.
Referans
- Environment variables - Pi süreç yapılandırması ve oturum meta verileri bash araçları tarafından kullanılabilir.
- Session format - JSONL oturum dosyası formatı, giriş türleri ve SessionManager API.
Platform kurulumu
Gelişim
- Development - yerel kurulum, proje yapısı ve hata ayıklama.