Sur cette page
Installer la CLI Patrii et s'y connecter
La CLI Patrii, patrii, vous permet de gérer vos projets et ressources depuis un terminal ou un script, avec les mêmes droits que dans la console.
La CLI est un paquet Python nommé patrii-cli. Elle communique uniquement avec l'API Patrii Cloud : chaque commande correspond à une action possible dans la console et respecte vos rôles dans le projet.
Vous pouvez vous connecter avec votre courriel et votre mot de passe (et votre code MFA s'il est activé), par authentification unique dans votre navigateur ou, pour les scripts et pipelines, avec un identifiant d'application qui n'exige aucune connexion interactive.
Concepts clés
Profil — Un ensemble enregistré d'identifiants et de valeurs par défaut. Utilisez plusieurs profils pour séparer des comptes ou des projets.
Identifiant d'application — Un ID et un secret propres à un projet, pour l'automatisation; voyez Projets et accès.
Format de sortie — Les résultats s'affichent en tableau par défaut; --output json ou --output yaml conviennent aux scripts.
Avant de commencer
- Python 3.12 ou plus récent et
pip. - Un compte Patrii Cloud et une paire de clés SSH sur votre poste : la CLI chiffre les identifiants qu'elle conserve avec votre clé publique SSH.
Étape par étape
- Installez le paquet
Installez
patrii-cliavec pip, idéalement dans un environnement virtuel, puis vérifiez quepatrii --versionrépond. - Enregistrez vos identifiants
Lancez
patrii config init. La commande demande l'URL de l'API (gardez la valeur par défaut), votre courriel, votre mot de passe et votre projet, puis les conserve chiffrés avec votre clé SSH. - Connectez-vous
- Lancez
patrii auth login. Si la MFA est activée, ajoutez--mfa-codeou définissezPATRII_MFA_CODE. - Préférez
patrii auth sso-loginsi votre organisation se connecte par SSO : la commande affiche un lien de vérification et ouvre votre navigateur.
- Lancez
- Choisissez le projet et le format
Les commandes utilisent votre projet par défaut. Changez-le avec
patrii project switch, ou remplacez-le pour une seule commande avec l'option globale--project. Les options globales se placent juste aprèspatrii. - Automatisez avec un identifiant d'application
Dans un pipeline, exportez
PATRII_APP_CREDENTIAL_IDetPATRII_APP_CREDENTIAL_SECRET; la CLI se connecte alors avec eux, sans mot de passe enregistré ni code MFA.
Exemples
python3 -m venv ~/.venvs/patrii source ~/.venvs/patrii/bin/activate pip install ./patrii-cli # dossier contenant le paquet patrii --version
patrii config init patrii auth login --mfa-code 123456 patrii auth whoami
patrii auth sso-login
patrii project list patrii --project <project-id> server list patrii --output json server list
patrii auth app-credential create --name ci-deploy # conservez le secret maintenant, il n'est affiché qu'une fois export PATRII_APP_CREDENTIAL_ID=<id-identifiant> export PATRII_APP_CREDENTIAL_SECRET=<secret-identifiant> patrii server list
patrii auth login --profile staging patrii auth use staging patrii auth list
Limites et caractéristiques
Options globales (avant la commande) :
| Option | Effet |
|---|---|
--project, -p | Exécute la commande dans un autre projet que celui par défaut. |
--output, -o | table (par défaut), json ou yaml. |
--region, -r | Remplace la région par défaut. |
--profile | Utilise un profil nommé pour cette commande. |
--debug | Affiche le détail des requêtes pour le dépannage. |
Bonnes pratiques
- Utilisez un identifiant d'application, jamais votre propre mot de passe, en CI et dans les scripts, et donnez-lui une date d'expiration.
- Utilisez
--output jsonquand un script lit le résultat.
Questions fréquentes
Puis-je utiliser la CLI avec les identifiants de Terraform ?
PATRII_APP_CREDENTIAL_ID et PATRII_APP_CREDENTIAL_SECRET, alors que le fournisseur Terraform lit PATRII_APPLICATION_CREDENTIAL_ID et PATRII_APPLICATION_CREDENTIAL_SECRET.Où trouver la liste complète des commandes ?
patrii --help, puis --help sur n'importe quel groupe ou commande, par exemple patrii server create --help.Pour aller plus loin
Tout ce que vous faites ici dans la console est aussi disponible via l'API Patrii Cloud pour l'automatisation et les scripts.