Konfiguration, Anpassung, Plattform-Einrichtung und API-Referenzen für Pi.

Schnellstart

Diese Seite führt Sie von der Installation bis zu einer nützlichen ersten Pi-Sitzung.

Installieren

Pi wird als npm-Paket verteilt:

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.

Deinstallieren

Verwenden Sie den Paketmanager, der pi installiert hat. Das Curl-Installationsprogramm verwendet npm global, daher werden Curl- und npm-Installationen 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-agent

Bei der Deinstallation von pi verbleiben Einstellungen, Anmeldeinformationen, Sitzungen und installierte Pi-Pakete in ~/.pi/agent/.

Starten Sie dann pi in dem Projektverzeichnis, in dem es arbeiten soll:

cd /path/to/project
pi

Authentifizieren

Pi kann subscription providers bis /login oder API-Schlüsselanbieter über Umgebungsvariablen oder die Authentifizierungsdatei verwenden.

Option 1: Abonnement-Login

Pi starten und ausführen:

/login

Wählen Sie dann einen Anbieter aus. Zu den integrierten Abonnement-Logins gehören Claude Pro/Max, ChatGPT Plus/Pro (Codex) und GitHub Copilot.

Option 2: API key

Stellen Sie eine API key ein, bevor Sie pi starten:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Sie können auch /login ausführen und einen API-Schlüsselanbieter auswählen, um den Schlüssel in ~/.pi/agent/auth.json zu speichern.

Unter Providers finden Sie alle unterstützten Anbieter, Umgebungsvariablen und die Einrichtung des Cloud-Anbieters.

Erste Sitzung

Sobald Pi startet, geben Sie eine Anfrage ein und drücken Sie die Eingabetaste:

Summarize this repository and tell me how to run its checks.

Standardmäßig stellt Pi dem Modell vier Werkzeuge zur Verfügung:

  • read – Dateien lesen
  • write – Dateien erstellen oder überschreiben
  • edit – Patchdateien
  • bash – Shell-Befehle ausführen

Zusätzliche integrierte schreibgeschützte Tools (grep, find, ls) sind über die Tool-Optionen verfügbar. Pi läuft in Ihrem aktuellen Arbeitsverzeichnis und kann dort Dateien ändern. Verwenden Sie Git oder einen anderen Checkpointing-Workflow, wenn Sie ein einfaches Rollback wünschen.

Geben Sie Anweisungen für das Pi-Projekt

Pi lädt context files beim Start. Fügen Sie eine AGENTS.md-Datei hinzu, um ihm mitzuteilen, wie in einem Projekt gearbeitet werden 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.md für globale Anweisungen
  • AGENTS.md oder CLAUDE.md aus übergeordneten Verzeichnissen und dem aktuellen Verzeichnis

Wenn ein Verzeichnis AGENTS.override.md enthält, lädt Pi es anstelle von AGENTS.md oder CLAUDE.md aus diesem Verzeichnis.

Starten Sie pi neu oder führen Sie /reload aus, nachdem Sie context files geändert haben.

Häufige Dinge zum Ausprobieren

Referenzdateien

Geben Sie @ in den Editor ein, um eine Fuzzy-Suche nach Dateien durchzuführen, oder übergeben Sie Dateien in 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 (Alt+V unter Windows) eingefügt werden; Bilder können auch in unterstützte Terminals gezogen werden.

Führen Sie Shell-Befehle aus

Im interaktiven Modus:

!npm run lint

Die Befehlsausgabe wird an das Modell gesendet. Verwenden Sie !!command, um einen Befehl auszuführen, ohne seine Ausgabe zum Modellkontext hinzuzufügen.

Modelle wechseln

Verwenden Sie /model oder Strg+L, um ein Modell auszuwählen. Verwenden Sie Umschalt+Tab, um die Denkebene zu wechseln. Verwenden Sie Strg+P/Umschalt+Strg+P, um durch die bereichsbezogenen Modelle zu blättern.

Fahren Sie später fort

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 session

Verwenden Sie in pi /resume, /new, /tree, /fork und /clone, um Sitzungen zu verwalten.

Nicht interaktiver Modus

Für einmalige Eingabeaufforderungen:

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 die JSON-Ereignisausgabe oder --mode rpc für die Prozessintegration.

Nächste Schritte

  • Using Pi – interaktiver Modus, slash commands Sitzungen, context files und CLI Referenz.
  • Providers – Authentifizierung und Modelleinrichtung.
  • Settings – globale und Projektkonfiguration.
  • Keybindings – Verknüpfungen und Anpassung.
  • Pi Packages – Gemeinsam genutzte Erweiterungen, Fähigkeiten, Eingabeaufforderungen und Themen installieren.

Plattformhinweise: Windows, Termux, tmux, Terminal setup, Shell aliases.