Hızlı başlangıç
Bu sayfa sizi kurulumdan yararlı bir ilk pi oturumuna götürür.
Düzenlemek
Pi, npm paketi olarak dağıtılır:
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.
Kaldır
Pi'yi yükleyen paket yöneticisini kullanın. Curl yükleyici genel olarak npm kullanır, dolayısıyla curl ve npm yüklemeleri npm ile kaldırılır:
# curl installer or npm install -g
npm uninstall -g @earendil-works/pi-coding-agent
# pnpm
pnpm remove -g @earendil-works/pi-coding-agent
# Yarn
yarn global remove @earendil-works/pi-coding-agent
# Bun
bun uninstall -g @earendil-works/pi-coding-agentPi'nin kaldırılması ayarları, kimlik bilgilerini, oturumları ve kurulu pi paketlerini ~/.pi/agent/'da bırakır.
Ardından üzerinde çalışmasını istediğiniz proje dizininde pi'yi başlatın:
cd /path/to/project
piKimlik doğrulama
Pi, ortam değişkenleri veya kimlik doğrulama dosyası aracılığıyla subscription providers ila /login veya API anahtar sağlayıcılarını kullanabilir.
Seçenek 1: abonelik girişi
Pi'yi başlatın ve çalıştırın:
/loginDaha sonra bir sağlayıcı seçin. Yerleşik abonelik oturum açma bilgileri arasında Claude Pro/Max, ChatGPT Plus/Pro (Codex) ve GitHub Copilot bulunur.
Seçenek 2: API key
Pi'yi başlatmadan önce bir API key ayarlayın:
export ANTHROPIC_API_KEY=sk-ant-...
piAyrıca /login komutunu çalıştırabilir ve anahtarı ~/.pi/agent/auth.json'de saklamak için bir API anahtar sağlayıcısı seçebilirsiniz.
Desteklenen tüm sağlayıcılar, ortam değişkenleri ve bulut sağlayıcı kurulumu için Providers'ye bakın.
İlk oturum
Pi başladıktan sonra bir istek yazın ve Enter'a basın:
Summarize this repository and tell me how to run its checks.Pi, varsayılan olarak modele dört araç sağlar:
read- dosyaları okuwrite- dosyalar oluşturun veya üzerine yazınedit- yama dosyalarıbash- kabuk komutlarını çalıştır
Ek yerleşik salt okunur araçlar (grep, find, ls) araç seçenekleri aracılığıyla kullanılabilir. Pi mevcut çalışma dizininizde çalışır ve oradaki dosyaları değiştirebilir. Kolay geri alma istiyorsanız git'i veya başka bir kontrol noktası oluşturma iş akışını kullanın.
Pi projesi talimatlarını verin
Pi başlangıçta context files'yi yükler. Bir projede nasıl çalışacağını anlatmak için bir AGENTS.md dosyası ekleyin:
# Project Instructions
- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.Pi yükler:
~/.pi/agent/AGENTS.mdgenel talimatlar içinAGENTS.mdveyaCLAUDE.mdüst dizinlerden ve geçerli dizinden
Bir dizin AGENTS.override.md içeriyorsa, Pi o dizindeki AGENTS.md veya CLAUDE.md yerine onu yükler.
Pi'yi yeniden başlatın veya context files'yi değiştirdikten sonra /reload'yi çalıştırın.
Denenecek yaygın şeyler
Referans dosyaları
Dosyalarda bulanık arama yapmak için düzenleyiciye @ yazın veya dosyaları komut satırına iletin:
pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"Resimler veya metinler Ctrl+V (Windows'ta Alt+V) tuşlarıyla yapıştırılabilir; görüntüler ayrıca desteklenen terminallere de sürüklenebilir.
Kabuk komutlarını çalıştır
Etkileşimli modda:
!npm run lintKomut çıktısı modele gönderilir. Bir komutu, çıktısını model bağlamına eklemeden çalıştırmak için !!command tuşunu kullanın.
Modelleri değiştir
Bir model seçmek için /model veya Ctrl+L tuşlarını kullanın. Düşünme düzeyini değiştirmek için Shift+Tab tuşlarını kullanın. Kapsamlı modeller arasında geçiş yapmak için Ctrl+P / Shift+Ctrl+P tuşlarını kullanın.
Daha sonra devam et
Oturumlar otomatik olarak kaydedilir:
pi -c # Continue most recent session
pi -r # Browse previous sessions
pi --name "my task" # Set session display name at startup
pi --session <path|id> # Open a specific sessionOturumları yönetmek için pi'nin içinde /resume, /new, /tree, /fork ve /clone tuşlarını kullanın.
Etkileşimsiz mod
Tek seferlik istemler için:
pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"JSON olay çıkışı için --mode json veya süreç entegrasyonu için --mode rpc kullanın.
Sonraki adımlar
- Using Pi - etkileşimli mod, slash commands, oturumlar, context files ve CLI referansı.
- Providers - kimlik doğrulama ve model kurulumu.
- Settings - genel ve proje yapılandırması.
- Keybindings - kısayollar ve özelleştirme.
- Pi Packages - paylaşılan uzantıları, becerileri, istemleri ve temaları yükleyin.
Platform notları: Windows, Termux, tmux, Terminal setup, Shell aliases.