Documentation Pi

Pi est un framework minimaliste de coding Agent pour le terminal. Son cœur reste volontairement léger et peut être étendu avec des extensions TypeScript, des Skills, des Prompt Templates, des Themes et des Pi Packages.

Installez Pi avec npm :

npm install -g --ignore-scripts @earendil-works/pi-coding-agent

--ignore-scripts désactive les scripts de cycle de vie des dépendances pendant l'installation. Pi ne requiert aucun script d'installation pour une installation npm normale.

Sous Linux ou macOS, vous pouvez aussi utiliser l'installateur :

curl -fsSL https://pi.dev/install.sh | sh

Pour désinstaller Pi lui-même lorsqu'il a été installé par l'installateur curl ou npm, utilisez npm :

npm uninstall -g @earendil-works/pi-coding-agent

Pour une installation avec pnpm, Yarn ou Bun, utilisez la commande globale de suppression correspondante : pnpm remove -g @earendil-works/pi-coding-agent, yarn global remove @earendil-works/pi-coding-agent ou bun uninstall -g @earendil-works/pi-coding-agent.

Exécutez-le ensuite dans un répertoire de projet :

pi

Pour les Provider sur abonnement, authentifiez-vous avec /login, ou définissez une API key telle que ANTHROPIC_API_KEY avant de démarrer pi.

Le flux complet de première exécution est décrit dans Quickstart.

• Quickstart - installer, s'authentifier et démarrer une première session.
• Using Pi - mode interactif, slash commands, context files et référence CLI.
• Providers - configuration des abonnements et API key pour les Provider intégrés.
• llama.cpp - exécuter un routeur local et gérer les modèles avec /llama.
• Security - confiance du projet, limites de sandbox et signalement des vulnérabilités.
• Containerization - isoler pi dans une sandbox avec Gondolin, Docker ou OpenShell.
• Settings - paramètres globaux et de projet.
• Keybindings - raccourcis par défaut et keybindings personnalisés.
• Sessions - gestion des sessions, branches et navigation dans l'arborescence.
• Compaction - compaction du contexte et résumés de branches.

• Extensions - modules TypeScript pour les outils, les commandes, les événements et une UI personnalisée.
• Skills - Agent Skills offrant des capacités réutilisables à la demande.
• Prompt templates - prompts réutilisables développés à partir de slash commands.
• Themes - thèmes de terminal intégrés et personnalisés.
• Pi packages - regrouper et partager extensions, Skills, prompts et thèmes.
• Custom models - ajouter des entrées de modèle pour les API de Provider prises en charge.
• Custom providers - implémenter des API et des flux OAuth personnalisés.

• SDK - intégrer pi à des applications Node.js.
• RPC mode - intégrer via stdin/stdout JSONL.
• JSON event stream mode - print mode avec des événements structurés.
• TUI components - créer une UI de terminal personnalisée pour les extensions.

• Environment variables - configuration du processus Pi et métadonnées de session disponibles pour les outils bash.
• Session format - format de fichier de session JSONL, types d'entrée et API SessionManager.

• Windows
• Termux on Android
• tmux
• Terminal setup
• Shell aliases

• Development - configuration locale, structure du projet et débogage.