Démarrage rapide

Cette page vous mène de l'installation à une première session pi utile.

Pi est distribué sous forme de package 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 n'a pas besoin de scripts d'installation pour les installations npm normales.

Utilisez le gestionnaire de packages qui a installé pi. L'installateur curl utilise npm globalement; les installations faites avec curl ou npm se suppriment donc avec npm:

# 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

Désinstaller pi conserve les paramètres, les identifiants, les sessions et les packages pi installés dans ~/.pi/agent/.

Démarrez ensuite pi dans le répertoire du projet sur lequel vous voulez le faire travailler:

cd /path/to/project
pi

Pi peut utiliser des fournisseurs avec abonnement via /login, ou des fournisseurs avec API key via des variables d'environnement ou le fichier d'authentification.

Démarrez pi et exécutez:

/login

Sélectionnez ensuite un fournisseur. Les connexions par abonnement intégrées incluent Claude Pro/Max, ChatGPT Plus/Pro (Codex) et GitHub Copilot.

Définissez une API key avant de lancer pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

Vous pouvez aussi exécuter /login et sélectionner un fournisseur avec API key pour stocker la clé dans ~/.pi/agent/auth.json.

Consultez Providers pour la liste des fournisseurs pris en charge, les variables d'environnement et la configuration des fournisseurs cloud.

Une fois pi démarré, saisissez une demande et appuyez sur Entrée:

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

Par défaut, pi fournit quatre outils au modèle:

• read - lire des fichiers
• write - créer ou écraser des fichiers
• edit - modifier des fichiers par patch
• bash - exécuter des commandes Shell

Des outils intégrés supplémentaires en lecture seule (grep, find, ls) sont disponibles via les options d'outils. Pi s'exécute dans votre répertoire de travail courant et peut y modifier des fichiers. Utilisez Git ou un autre workflow de checkpoint si vous voulez pouvoir revenir facilement en arrière.

Pi charge des context files au démarrage. Ajoutez un fichier AGENTS.md pour lui indiquer comment travailler dans un projet:

# Project Instructions

- Run `npm run check` after code changes.
- Do not run production migrations locally.
- Keep responses concise.

Pi charge:

• ~/.pi/agent/AGENTS.md pour les instructions globales
• AGENTS.md ou CLAUDE.md depuis les répertoires parents et le répertoire courant

Si un répertoire contient AGENTS.override.md, Pi charge ce fichier au lieu de AGENTS.md ou CLAUDE.md depuis ce répertoire.

Redémarrez pi ou exécutez /reload après avoir modifié des context files.

Tapez @ dans l'éditeur pour rechercher des fichiers de façon approximative, ou passez des fichiers sur la ligne de commande:

pi @README.md "Summarize this"
pi @src/app.ts @src/app.test.ts "Review these together"

Vous pouvez coller des images ou du texte avec Ctrl+V (Alt+V sous Windows); les images peuvent aussi être glissées dans les terminaux compatibles.

En mode interactif:

!npm run lint

La sortie de la commande est envoyée au modèle. Utilisez !!command pour exécuter une commande sans ajouter sa sortie au contexte du modèle.

Utilisez /model ou Ctrl+L pour choisir un modèle. Utilisez Shift+Tab pour changer de thinking level. Utilisez Ctrl+P / Shift+Ctrl+P pour parcourir les scoped models.

Les sessions sont enregistrées automatiquement:

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

Dans pi, utilisez /resume, /new, /tree, /fork et /clone pour gérer les sessions.

Pour les prompts ponctuels:

pi -p "Summarize this codebase"
cat README.md | pi -p "Summarize this text"
pi -p @screenshot.png "What's in this image?"

Utilisez --mode json pour une sortie d'événements JSON, ou --mode rpc pour une intégration avec un autre processus.

• Using Pi - mode interactif, slash commands, sessions, context files et référence CLI.
• Providers - authentification et configuration des modèles.
• Settings - configuration globale et projet.
• Keybindings - raccourcis et personnalisation.
• Pi Packages - installer des extensions, Skills, Prompts et Themes partagés.

Notes de plateforme: Windows, Termux, tmux, Terminal setup, Shell aliases.