Démarrage rapide

Cette page vous amè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 ne nécessite pas de scripts d'installation pour les installations npm normales.

Utilisez le gestionnaire de packages qui a installé pi. Le programme d'installation de curl utilise npm globalement, donc les installations curl et npm sont supprimées 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

La désinstallation de pi laisse les paramètres, les informations d'identification, les sessions et les packages pi installés dans ~/.pi/agent/.

Ensuite, démarrez pi dans le répertoire du projet sur lequel vous souhaitez qu'il fonctionne:

cd /path/to/project
pi

Pi peut utiliser subscription providers à /login, ou API-fournisseurs de clés via des variables d'environnement ou le fichier d'authentification.

Démarrez pi et exécutez:

/login

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

Définissez un API key avant de lancer pi:

export ANTHROPIC_API_KEY=sk-ant-...
pi

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

Voir Providers pour tous les fournisseurs pris en charge, les variables d'environnement et la configuration du fournisseur de cloud.

Une fois pi démarré, tapez une requête et appuyez sur Entrée:

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

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

• read - lire les fichiers
• write - créer ou écraser des fichiers
• edit - fichiers de correctifs
• bash - exécuter les commandes shell

Des outils supplémentaires intégrés en lecture seule (grep, find, ls) sont disponibles via les options d'outils. Pi s'exécute dans votre répertoire de travail actuel et peut y modifier des fichiers. Utilisez git ou un autre workflow de point de contrôle si vous souhaitez une restauration facile.

Pi charge 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 charges:

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

Si un répertoire contient AGENTS.override.md, Pi le charge au lieu de AGENTS.md ou CLAUDE.md à partir de ce répertoire.

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

Tapez @ dans l'éditeur pour effectuer une recherche floue dans les fichiers ou transmettez les fichiers sur la ligne de commande:

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

Les images ou le texte peuvent être collés avec Ctrl+V (Alt+V sous Windows); les images peuvent également être glissées vers des terminaux pris en charge.

En mode interactif:

!npm run lint

Le résultat de la commande est envoyé 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 faire défiler le niveau de réflexion. Utilisez Ctrl+P / Shift+Ctrl+P pour parcourir les modèles étendus.

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 invites ponctuelles:

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 la sortie d'événement JSON ou --mode rpc pour l'intégration de processus.

• Using Pi - mode interactif, slash commands, sessions, context files et CLI référence.
• Providers - authentification et configuration du modèle.
• Settings - configuration globale et projet.
• Keybindings - raccourcis et personnalisation.
• Pi Packages - installez des extensions, des compétences, des invites et des thèmes partagés.

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