Manuel de référence de la CLI de Pi Agent
Voici une référence pour les paramètres de ligne de commande courants de Pi Agent.
Options de mode
Les paramètres suivants contrôlent le mode d'exécution de Pi Agent. S'ils ne sont pas spécifiés, il entre par défaut dans l'interface interactive.
| Paramètre | Description | Exemple |
|---|---|---|
| (Par défaut) | Mode interactif, interface TUI du terminal | pi |
| -p, --print | Mode d'impression, quitte après avoir affiché le résultat | pi -p "summarize code" |
| --mode json | Mode JSON, tous les événements sont émis en lignes JSON | pi --mode json -p "summarize" |
| --mode rpc | Mode RPC, protocole JSONL sur stdin/stdout | pi --mode rpc |
| --export <input> [output] | Exporter la session en HTML ; le chemin de sortie peut être omis | pi --export abc123 session.html |
Options du modèle
Les paramètres suivants sont utilisés pour spécifier le fournisseur, le modèle et le niveau de raisonnement, adaptés à un basculement temporaire sans modifier les fichiers de configuration.
| Paramètre | Description | Exemple |
|---|---|---|
| --provider name | Spécifier le fournisseur d'IA | pi --provider anthropic |
| --model motif | ID du modèle, prend en charge les formats provider/id et :thinking | pi --model openai/gpt-4o pi --model sonnet:high |
| --api-key clé | Transmettez la clé API directement, avec la priorité la plus élevée ; remplacez la valeur d'exemple par votre propre clé | pi --api-key sk-ant-api03-xxxx |
| --thinking niveau | Niveau de raisonnement : off/minimal/low/medium/high/xhigh/max | pi --thinking high |
| --models motifs | Liste de modèles séparés par des virgules, limite le cycle Ctrl+P | pi --models "claude-*,gpt-4o" |
| --list-models | Lister tous les modèles disponibles | pi --list-models |
Options de session
Les paramètres suivants déterminent quelle session est utilisée dans cette exécution et où les fichiers de session sont enregistrés.
| Paramètre | Description | Exemple |
|---|---|---|
| -c, --continue | Continuer la session la plus récente | pi -c |
| -r, --resume | Parcourir et sélectionner une session historique | pi -r |
| --session path|id | Utiliser un fichier de session spécifié ou un UUID | pi --session abc123 |
| --fork path|id | Créer une nouvelle session à partir de la session spécifiée | pi --fork abc123 |
| --session-dir dir | Répertoire de stockage des sessions personnalisé ; le répertoire par défaut est ~/.pi/agent/sessions/, ce paramètre le remplace temporairement | pi --session-dir .pi/sessions |
| --no-session | Mode temporaire, ne sauvegarde pas les sessions | pi --no-session |
| -n, --name name | Définir le nom d'affichage de la session | pi --name "Refactoriser le module d'authentification" |
Options des outils
Les paramètres suivants contrôlent la disponibilité des outils intégrés, utilisés pour resserrer les autorisations ou pour une conversation pure.
| Paramètre | Description | Exemple |
|---|---|---|
| -t, --tools list | Mettre les outils spécifiés en liste blanche, séparés par des virgules | pi --tools read,bash,edit,write |
| -xt, --exclude-tools list | Désactiver les outils spécifiés, séparés par des virgules | pi --exclude-tools bash |
| -nbt, --no-builtin-tools | Désactiver tous les outils intégrés, conserver les outils d'extension | pi --no-builtin-tools |
| -nt, --no-tools | Désactiver tous les outils, mode conversation pure | pi --no-tools |
Options de ressources
Les paramètres suivants contrôlent le chargement des extensions, des Skills, des modèles et des thèmes. Les paramètres avec le préfixe --no- servent à désactiver la découverte automatique.
| Paramètre | Description | Exemple |
|---|---|---|
| -e, --extension source | Charger une extension, peut être utilisé plusieurs fois | pi -e ./my-ext.ts -e npm:@foo/bar |
| --no-extensions | Désactiver la découverte automatique des extensions | pi --no-extensions |
| --skill path | Charger une Skill, utilisable plusieurs fois | pi --skill ./my-skill |
| --no-skills | Désactiver la découverte automatique des Skills | pi --no-skills |
| --prompt-template path | Charger un modèle de prompt, utilisable plusieurs fois | pi --prompt-template ./review.md |
| --no-prompt-templates | Désactiver la découverte automatique des modèles | pi --no-prompt-templates |
| --theme path | Charger un thème, peut être utilisé plusieurs fois | pi --theme ./my-theme.json |
| --no-themes | Désactiver la découverte automatique des thèmes | pi --no-themes |
| -nc, --no-context-files | Désactiver le chargement des fichiers AGENTS.md/CLAUDE.md | pi -nc |
Autres options
Les paramètres suivants remplacent des comportements tels que le prompt système, la confiance du projet et les informations d'aide.
| Paramètre | Description | Exemple |
|---|---|---|
| --system-prompt text | Remplacer le prompt système par défaut | pi --system-prompt "Vous êtes un expert Python" |
| --append-system-prompt texte | Ajouter au prompt système | pi --append-system-prompt "Répondez en chinois" |
| --tui-mode | Mode d'interface, par exemple fullscreen ; s'il n'est pas spécifié, le mode normal est utilisé | pi --tui-mode fullscreen |
| --use-theme | Spécifier un thème à charger ; n'a d'effet que pour l'exécution en cours, ne modifie pas la configuration | pi --use-theme "dark-plus" |
| --verbose | Forcer l'affichage des informations détaillées de démarrage | pi --verbose |
| -a, --approve | Faire confiance aux fichiers locaux du projet pour cette exécution | pi -a |
| -na, --no-approve | Ne pas faire confiance aux fichiers locaux du projet pour cette exécution | pi -na |
| -- | Séparateur ; le contenu après celui-ci est transmis au prompt tel quel | pi -- @notes.md Résumez cette note |
| -h, --help | Afficher les informations d'aide | pi -h |
| -v, --version | Afficher le numéro de version | pi -v |
-aet-nasont mutuellement exclusifs ; un seul peut être spécifié dans la même exécution.
Les deux sont limités uniquement à l'exécution en cours et ne seront pas écrits dans trust.json.
Sous-commandes de pi
En plus des paramètres de démarrage, pi fournit également un ensemble de sous-commandes pour gérer les paquets d'extension et ses propres mises à jour.
| Sous-commande | Description |
|---|---|
| pi install <source> | Installer un paquet d'extension ; ajoutez -l pour installer localement dans le projet |
| pi remove <source> | Supprimer un paquet d'extension installé |
| pi uninstall <source> | Alias de remove, même effet |
| pi list | Lister les paquets d’extension installés |
| pi update | Mettre à jour pi lui-même et les paquets d’extension ; prend en charge --self, --all, --models, --extensions, --extension <source> |
| pi config | Activer ou désactiver diverses ressources fournies par les paquets d’extension |
Variables d’environnement associées
Les variables d’environnement suivantes affectent l’authentification, le réseau et le comportement du terminal, et peuvent servir de configuration supplémentaire au-delà des paramètres de ligne de commande.
| Variable | Objectif | Exemple |
|---|---|---|
| ANTHROPIC_API_KEY | Méthode alternative pour l’authentification Anthropic ; utilisée lorsqu’on n’est pas connecté via l’abonnement /login | sk-ant-api03-xxxx |
| HTTP_PROXY / HTTPS_PROXY | Spécifier un serveur proxy pour les requêtes API | http://127.0.0.1:7890 |
| NO_PROXY | Liste blanche de proxy ; les hôtes correspondants ne passent pas par le proxy | localhost,127.0.0.1 |
| COLORTERM | L'une des valeurs de référence pour la détection automatique de truecolor ; si la détection échoue, utilisez PI_TRUE_COLOR=1 pour forcer l'activation, ou configurez terminal.trueColor | truecolor |
Pour les proxies qui nécessitent une utilisation à long terme, il est recommandé d'écrire dans~/.pi/agent/settings.jsonle paramètrehttpProxy。
Cette configuration ne prend effet que dans le fichier de configuration global ; l'écrire au niveau du projet.pi/settings.jsonest invalide.
Arguments de fichier
Utilisation@Préfixe pour référencer les fichiers :
$ pi @prompt.md "回答这个问题" $ pi -p @screenshot.png "图中有什么" $ pi @src/code.ts @src/test.ts "对比这两个文件"
En prenant la deuxième commande comme exemple, la sortie est similaire à :
The image is a screenshot of a login page, which includes a username input field, a password input field, and a login button.Autres extensions