Schnellstart
Diese Seite führt von der Installation zu einer ersten nützlichen pi-Sitzung.
Installation
Pi wird als npm-Paket verteilt:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts deaktiviert Lifecycle-Skripte von Abhängigkeiten während der Installation. Für normale npm-Installationen benötigt Pi keine Installationsskripte.
Deinstallation
Verwenden Sie den Paketmanager, mit dem pi installiert wurde. Der curl-Installer nutzt global npm; Installationen per curl oder npm werden daher mit npm entfernt:
# 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-agentBeim Deinstallieren von pi bleiben Einstellungen, Zugangsdaten, Sitzungen und installierte pi-Pakete unter ~/.pi/agent/ erhalten.
Starten Sie pi anschließend in dem Projektverzeichnis, in dem es arbeiten soll:
cd /path/to/project
piAuthentifizierung
Pi kann Subscription-Provider über /login verwenden. API-Key-Provider können über Umgebungsvariablen oder die Auth-Datei konfiguriert werden.
Option 1: Subscription-Login
Starten Sie pi und führen Sie aus:
/loginWählen Sie anschließend einen Provider aus. Die integrierten Subscription-Logins umfassen Claude Pro/Max, ChatGPT Plus/Pro (Codex) und GitHub Copilot.
Option 2: API Key
Setzen Sie vor dem Start von pi einen API Key:
export ANTHROPIC_API_KEY=sk-ant-...
piSie können auch /login ausführen und einen API-Key-Provider auswählen, um den Key in ~/.pi/agent/auth.json zu speichern.
Eine vollständige Liste der unterstützten Provider, Umgebungsvariablen und Cloud-Provider-Einstellungen finden Sie unter Providers.
Erste Sitzung
Nachdem pi gestartet ist, geben Sie eine Anfrage ein und drücken Enter:
Summarize this repository and tell me how to run its checks.Standardmäßig stellt pi dem Modell vier Tools bereit:
read- Dateien lesenwrite- Dateien erstellen oder überschreibenedit- Dateien per Patch ändernbash- Shell-Befehle ausführen
Weitere integrierte Read-only-Tools (grep, find, ls) sind über Tool-Optionen verfügbar. Pi läuft im aktuellen Arbeitsverzeichnis und kann dort Dateien ändern. Verwenden Sie Git oder einen anderen Checkpoint-Workflow, wenn Sie Änderungen einfach zurücksetzen möchten.
Projektanweisungen für pi
Pi lädt beim Start context files. Fügen Sie eine Datei AGENTS.md hinzu, um Pi mitzuteilen, wie es in einem Projekt arbeiten soll:
# Project Instructions
- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.Pi lädt:
~/.pi/agent/AGENTS.mdfür globale AnweisungenAGENTS.mdoderCLAUDE.mdaus übergeordneten Verzeichnissen und dem aktuellen Verzeichnis
Wenn ein Verzeichnis AGENTS.override.md enthält, lädt Pi diese Datei anstelle von AGENTS.md oder CLAUDE.md aus demselben Verzeichnis.
Starten Sie pi neu oder führen Sie /reload aus, nachdem Sie context files geändert haben.
Häufige Dinge zum Ausprobieren
Dateien referenzieren
Geben Sie @ im Editor ein, um Dateien per Fuzzy Search zu finden, oder übergeben Sie Dateien auf der Befehlszeile:
pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"Bilder oder Text können mit Strg+V eingefügt werden (unter Windows mit Alt+V); Bilder können auch in unterstützte Terminals gezogen werden.
Shell-Befehle ausführen
Im interaktiven Modus:
!npm run lintDie Befehlsausgabe wird an das Modell gesendet. Mit !!command führen Sie einen Befehl aus, ohne dessen Ausgabe zum Modellkontext hinzuzufügen.
Modelle wechseln
Wählen Sie mit /model oder Strg+L ein Modell aus. Mit Umschalt+Tab wechseln Sie den thinking level. Mit Strg+P / Umschalt+Strg+P wechseln Sie durch scoped models.
Später fortsetzen
Sitzungen werden automatisch gespeichert:
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 sessionInnerhalb von pi können Sie Sitzungen mit /resume, /new, /tree, /fork und /clone verwalten.
Nicht interaktiver Modus
Für einmalige Prompts:
pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"Verwenden Sie --mode json für JSON-Event-Ausgabe oder --mode rpc für Prozessintegration.
Nächste Schritte
- Using Pi - interaktiver Modus, slash commands, Sitzungen, context files und CLI-Referenz.
- Providers - Authentifizierung und Modelleinrichtung.
- Settings - globale und projektspezifische Konfiguration.
- Keybindings - Tastenkürzel und Anpassung.
- Pi Packages - gemeinsame Erweiterungen, Skills, Prompts und Themes installieren.
Plattformhinweise: Windows, Termux, tmux, Terminal setup, Shell aliases.