Pi Dokumentation
Pi ist ein Kabelbaum mit minimaler Klemmenkodierung. Es ist so konzipiert, dass es im Kern klein bleibt und gleichzeitig durch TypeScript Erweiterungen, Fähigkeiten, prompt templates, Themen und Pi-Pakete erweitert wird.
Schnellstart
Installieren Sie Pi mit npm:
npm install -g --ignore-scripts @earendil-works/pi-coding-agent--ignore-scripts deaktiviert Abhängigkeitslebenszyklusskripte während der Installation. Pi erfordert keine Installationsskripte für normale npm-Installationen.
Unter Linux oder macOS können Sie auch den Installer verwenden:
curl -fsSL https://pi.dev/install.sh | shUm Pi selbst zu deinstallieren, verwenden Sie npm für Curl und npm für die Installation:
npm uninstall -g @earendil-works/pi-coding-agentVerwenden Sie für pnpm-, Yarn- oder Bun-Installationen den entsprechenden 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 es dann in einem Projektverzeichnis aus:
piAuthentifizieren Sie sich mit /login für subscription providers oder legen Sie ein API key wie ANTHROPIC_API_KEY fest, bevor Sie pi starten.
Den vollständigen Ablauf für den ersten Lauf finden Sie unter Quickstart.
Beginnen Sie hier
- Quickstart – Installieren, authentifizieren und eine erste Sitzung ausführen.
- Using Pi – interaktiver Modus, slash commands, context files und CLI Referenz.
- Providers – Abonnement und API-Schlüssel-Setup für integrierte Anbieter.
- llama.cpp – Führen Sie einen lokalen Router aus und verwalten Sie Modelle mit
/llama. - Security – Projektvertrauen, sandbox Grenzen und Schwachstellenmeldung.
- Containerization - sandbox pi mit Gondolin, Docker oder OpenShell.
- Settings – globale und Projekteinstellungen.
- Keybindings – Standardverknüpfungen und benutzerdefinierte Tastenkombinationen.
- Sessions – Sitzungsverwaltung, Verzweigung und Baumnavigation.
- Compaction - context compaction und branch summarization.
Anpassung
- Extensions – TypeScript Module für Tools, Befehle, Ereignisse und benutzerdefinierte Benutzeroberfläche.
- Skills – Agent Skills für wiederverwendbare On-Demand-Funktionen.
- Prompt templates – wiederverwendbare Eingabeaufforderungen, die ab slash commands erweitert werden.
- Themes – integriert und benutzerdefiniert terminal themes.
- Pi packages – Bündeln und teilen Sie Erweiterungen, Fähigkeiten, Eingabeaufforderungen und Themen.
- Custom models – Modelleinträge für unterstützte Anbieter APIs hinzufügen.
- Custom providers – benutzerdefinierte APIs- und OAuth-Flows implementieren.
Programmatische Nutzung
- SDK – Pi in Node.js Anwendungen einbetten.
- RPC mode – Integration über stdin/stdout JSONL.
- JSON event stream mode – Druckmodus mit strukturierten Ereignissen.
- TUI components – Erstellen Sie eine benutzerdefinierte Terminal-Benutzeroberfläche für Erweiterungen.
Referenz
- Environment variables – Pi Prozesskonfiguration und Sitzungsmetadaten, die für bash Tools verfügbar sind.
- Session format - JSONL Sitzungsdateiformat, Eintragstypen und SessionManager API.
Plattform-Setup
Entwicklung
- Development – lokale Einrichtung, Projektstruktur und Debugging.