Pi-Dokumentation
Pi ist ein minimalistisches Framework für Coding-Agents im Terminal. Der Kern bleibt bewusst schlank und lässt sich durch TypeScript-Erweiterungen, Skills, Prompt Templates, Themes und Pi Packages erweitern.
Schnellstart
Installieren Sie Pi mit npm:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts deaktiviert während der Installation die Lebenszyklusskripte von Abhängigkeiten. Für eine normale npm-Installation benötigt Pi keine Installationsskripte.
Unter Linux oder macOS können Sie auch den Installer verwenden:
curl -fsSL https://pi.dev/install.sh | shUm Pi selbst zu deinstallieren, wenn es über den curl-Installer oder npm installiert wurde, verwenden Sie npm:
npm uninstall -g @earendil-works/pi-coding-agentBei Installationen mit pnpm, Yarn oder Bun verwenden Sie den passenden globalen Entfernungsbefehl: pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent oder bun uninstall -g @earendil-works/pi-coding-agent.
Führen Sie Pi anschließend in einem Projektverzeichnis aus:
piAuthentifizieren Sie sich für Subscription Provider mit /login, oder setzen Sie vor dem Start von pi einen API key wie ANTHROPIC_API_KEY.
Den vollständigen Ablauf beim ersten Start finden Sie unter Quickstart.
Erste Schritte
- Quickstart - Pi installieren, authentifizieren und eine erste Sitzung starten.
- Using Pi - interaktiver Modus, slash commands, context files und CLI-Referenz.
- Providers - Subscription- und API-key-Einrichtung für integrierte Provider.
- llama.cpp - einen lokalen Router ausführen und Modelle mit
/llamaverwalten. - Security - Projektvertrauen, sandbox-Grenzen und Meldung von Sicherheitslücken.
- Containerization - pi mit Gondolin, Docker oder OpenShell in einer sandbox isolieren.
- Settings - globale Einstellungen und Projekteinstellungen.
- Keybindings - Standardkürzel und benutzerdefinierte Tastenkürzel.
- Sessions - Sitzungsverwaltung, Verzweigungen und Baumnavigation.
- Compaction - Kontextkomprimierung und Branch-Zusammenfassungen.
Anpassung
- Extensions - TypeScript-Module für Tools, Befehle, Ereignisse und benutzerdefinierte UI.
- Skills - Agent Skills für wiederverwendbare On-Demand-Funktionen.
- Prompt templates - wiederverwendbare Prompts, die sich über slash commands erweitern lassen.
- Themes - integrierte und benutzerdefinierte Terminal-Themes.
- Pi packages - Erweiterungen, Skills, Prompts und Themes bündeln und teilen.
- Custom models - Modelleinträge für unterstützte Provider APIs hinzufügen.
- Custom providers - eigene APIs und OAuth-Flows implementieren.
Programmatische Verwendung
- SDK - pi in Node.js-Anwendungen einbetten.
- RPC mode - über stdin/stdout JSONL integrieren.
- JSON event stream mode - print mode mit strukturierten Ereignissen.
- TUI components - eine eigene Terminal-UI für Erweiterungen erstellen.
Referenz
- Environment variables - Pi-Prozesskonfiguration und Sitzungsmetadaten, die bash-Tools zur Verfügung stehen.
- Session format - JSONL-Sitzungsdateiformat, Eintragstypen und SessionManager API.
Plattform-Setup
Entwicklung
- Development - lokale Einrichtung, Projektstruktur und Debugging.