Se rendre au contenu
Open Beta — managed Kubernetes, DNS & more are live.
💻

Installer la CLI Patrii et s'y connecter

Updated 2026-11-20
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

  1. Installez le paquet

    Installez patrii-cli avec pip, idéalement dans un environnement virtuel, puis vérifiez que patrii --version répond.

  2. 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.

  3. Connectez-vous
    • Lancez patrii auth login. Si la MFA est activée, ajoutez --mfa-code ou définissez PATRII_MFA_CODE.
    • Préférez patrii auth sso-login si votre organisation se connecte par SSO : la commande affiche un lien de vérification et ouvre votre navigateur.
  4. 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ès patrii.

  5. Automatisez avec un identifiant d'application

    Dans un pipeline, exportez PATRII_APP_CREDENTIAL_ID et PATRII_APP_CREDENTIAL_SECRET; la CLI se connecte alors avec eux, sans mot de passe enregistré ni code MFA.

Exemples

Installer et vérifier
python3 -m venv ~/.venvs/patrii
source ~/.venvs/patrii/bin/activate
pip install ./patrii-cli    # dossier contenant le paquet
patrii --version
Enregistrer les identifiants et se connecter
patrii config init
patrii auth login --mfa-code 123456
patrii auth whoami
Se connecter par SSO
patrii auth sso-login
Options globales : projet et format de sortie
patrii project list
patrii --project <project-id> server list
patrii --output json server list
Utiliser un identifiant d'application dans un pipeline
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
Séparer plusieurs comptes avec des profils
patrii auth login --profile staging
patrii auth use staging
patrii auth list

Limites et caractéristiques

Options globales (avant la commande) :

OptionEffet
--project, -pExécute la commande dans un autre projet que celui par défaut.
--output, -otable (par défaut), json ou yaml.
--region, -rRemplace la région par défaut.
--profileUtilise un profil nommé pour cette commande.
--debugAffiche 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 json quand un script lit le résultat.

Questions fréquentes

Puis-je utiliser la CLI avec les identifiants de Terraform ?
Oui, le même identifiant d'application sert aux deux, mais les noms de variables diffèrent : la CLI lit 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 ?
Lancez 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.

Cet article vous a-t-il été utile?
Merci de votre rétroaction. Toujours bloqué? Écrivez-nous