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ètreDescriptionExemple
(Par défaut)Mode interactif, interface TUI du terminalpi
-p, --printMode d'impression, quitte après avoir affiché le résultatpi -p "summarize code"
--mode jsonMode JSON, tous les événements sont émis en lignes JSONpi --mode json -p "summarize"
--mode rpcMode RPC, protocole JSONL sur stdin/stdoutpi --mode rpc
--export <input> [output]Exporter la session en HTML ; le chemin de sortie peut être omispi --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ètreDescriptionExemple
--provider nameSpécifier le fournisseur d'IApi --provider anthropic
--model motifID du modèle, prend en charge les formats provider/id et :thinkingpi --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 niveauNiveau de raisonnement : off/minimal/low/medium/high/xhigh/maxpi --thinking high
--models motifsListe de modèles séparés par des virgules, limite le cycle Ctrl+Ppi --models "claude-*,gpt-4o"
--list-modelsLister tous les modèles disponiblespi --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ètreDescriptionExemple
-c, --continueContinuer la session la plus récentepi -c
-r, --resumeParcourir et sélectionner une session historiquepi -r
--session path|idUtiliser un fichier de session spécifié ou un UUIDpi --session abc123
--fork path|idCréer une nouvelle session à partir de la session spécifiéepi --fork abc123
--session-dir dirRépertoire de stockage des sessions personnalisé ; le répertoire par défaut est ~/.pi/agent/sessions/, ce paramètre le remplace temporairementpi --session-dir .pi/sessions
--no-sessionMode temporaire, ne sauvegarde pas les sessionspi --no-session
-n, --name nameDéfinir le nom d'affichage de la sessionpi --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ètreDescriptionExemple
-t, --tools listMettre les outils spécifiés en liste blanche, séparés par des virgulespi --tools read,bash,edit,write
-xt, --exclude-tools listDésactiver les outils spécifiés, séparés par des virgulespi --exclude-tools bash
-nbt, --no-builtin-toolsDésactiver tous les outils intégrés, conserver les outils d'extensionpi --no-builtin-tools
-nt, --no-toolsDésactiver tous les outils, mode conversation purepi --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ètreDescriptionExemple
-e, --extension sourceCharger une extension, peut être utilisé plusieurs foispi -e ./my-ext.ts -e npm:@foo/bar
--no-extensionsDésactiver la découverte automatique des extensionspi --no-extensions
--skill pathCharger une Skill, utilisable plusieurs foispi --skill ./my-skill
--no-skillsDésactiver la découverte automatique des Skillspi --no-skills
--prompt-template pathCharger un modèle de prompt, utilisable plusieurs foispi --prompt-template ./review.md
--no-prompt-templatesDésactiver la découverte automatique des modèlespi --no-prompt-templates
--theme pathCharger un thème, peut être utilisé plusieurs foispi --theme ./my-theme.json
--no-themesDésactiver la découverte automatique des thèmespi --no-themes
-nc, --no-context-filesDésactiver le chargement des fichiers AGENTS.md/CLAUDE.mdpi -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ètreDescriptionExemple
--system-prompt textRemplacer le prompt système par défautpi --system-prompt "Vous êtes un expert Python"
--append-system-prompt texteAjouter au prompt systèmepi --append-system-prompt "Répondez en chinois"
--tui-modeMode d'interface, par exemple fullscreen ; s'il n'est pas spécifié, le mode normal est utilisépi --tui-mode fullscreen
--use-themeSpécifier un thème à charger ; n'a d'effet que pour l'exécution en cours, ne modifie pas la configurationpi --use-theme "dark-plus"
--verboseForcer l'affichage des informations détaillées de démarragepi --verbose
-a, --approveFaire confiance aux fichiers locaux du projet pour cette exécutionpi -a
-na, --no-approveNe pas faire confiance aux fichiers locaux du projet pour cette exécutionpi -na
--Séparateur ; le contenu après celui-ci est transmis au prompt tel quelpi -- @notes.md Résumez cette note
-h, --helpAfficher les informations d'aidepi -h
-v, --versionAfficher le numéro de versionpi -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-commandeDescription
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 listLister les paquets d’extension installés
pi updateMettre à jour pi lui-même et les paquets d’extension ; prend en charge --self, --all, --models, --extensions, --extension <source>
pi configActiver 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.

VariableObjectifExemple
ANTHROPIC_API_KEYMéthode alternative pour l’authentification Anthropic ; utilisée lorsqu’on n’est pas connecté via l’abonnement /loginsk-ant-api03-xxxx
HTTP_PROXY / HTTPS_PROXYSpécifier un serveur proxy pour les requêtes APIhttp://127.0.0.1:7890
NO_PROXYListe blanche de proxy ; les hôtes correspondants ne passent pas par le proxylocalhost,127.0.0.1
COLORTERML'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.trueColortruecolor

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