Pi Documentation

Pi est un faisceau de codage de terminal minimal. Il est conçu pour rester petit à la base tout en étant étendu via TypeScript extensions, compétences, prompt templates, thèmes et packages pi.

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 nécessite pas de scripts d'installation pour les installations npm normales.

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

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

Pour désinstaller pi lui-même, utilisez npm pour les installations curl et npm:

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

Pour les installations pnpm, Yarn ou Bun, utilisez la commande de suppression globale 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.

Ensuite, exécutez-le dans un répertoire de projet:

pi

Authentifiez-vous avec /login pour subscription providers, ou définissez un API key tel que ANTHROPIC_API_KEY avant de démarrer pi.

Pour le flux complet de première exécution, voir Quickstart.

• Quickstart - installez, authentifiez-vous et exécutez une première session.
• Using Pi - mode interactif, référence slash commands, context files et CLI.
• Providers - abonnement et configuration de la touche API pour les fournisseurs intégrés.
• llama.cpp - exécutez un routeur local et gérez les modèles avec /llama.
• Security - confiance dans le projet, limites sandbox et rapports de vulnérabilité.
• Containerization - sandbox pi avec Gondolin, Docker ou OpenShell.
• Settings - paramètres globaux et du projet.
• Keybindings - raccourcis par défaut et raccourcis clavier personnalisés.
• Sessions - gestion de session, branchement et navigation dans l'arborescence.
• Compaction - context compaction et branch summarization.

• Extensions - TypeScript modules pour les outils, les commandes, les événements et l'interface utilisateur personnalisée.
• Skills - Agent Skills pour des fonctionnalités réutilisables à la demande.
• Prompt templates - invites réutilisables qui s'étendent à partir de slash commands.
• Themes - terminal themes intégré et personnalisé.
• Pi packages - regroupez et partagez des extensions, des compétences, des invites et des thèmes.
• Custom models - ajoute des entrées de modèle pour les fournisseurs pris en charge APIs.
• Custom providers - implémentez des flux API et OAuth personnalisés.

• SDK - intégrer pi dans les applications Node.js.
• RPC mode - intégrer sur stdin/stdout JSONL.
• JSON event stream mode - mode d'impression avec événements structurés.
• TUI components - créez une interface utilisateur de terminal personnalisée pour les extensions.

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

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

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