Skip to main content
1

Lancer la connexion

Exécutez la commande de connexion dans votre terminal :
La CLI affiche un code court et ouvre la page d’autorisation dans votre navigateur.
2

Approuver dans le navigateur

Saisissez le code sur la page et approuvez. La CLI reçoit sa propre clé API, sans copier-coller, et l’enregistre sur cette machine.
Sortie
Une clé émise de cette façon ne dispose que des permissions utilisées par les commandes de la CLI et expire au bout de 90 jours. auth whoami affiche la date ; exécutez à nouveau squarecloud auth login pour la renouveler. La clé est enregistrée dans un fichier config.json lisible par vous seul : dans %APPDATA%\Square Cloud CLI sous Windows, et dans $XDG_CONFIG_HOME/squarecloud ou ~/.config/squarecloud sous macOS et Linux.

​
squarecloud auth login

Utilisation
Sortie avec une clé API
  • Appuyez sur Ctrl+C pour annuler une connexion en attente d’approbation.
  • Si cette machine est déjà connectée à un autre compte, auth login demande confirmation avant de le remplacer. Passez -y pour ignorer la question.
  • Si votre compte a atteint sa limite de clés API, la connexion par navigateur l’indique et reprend d’elle-même dès que vous révoquez une clé dans le tableau de bord.
  • Sans terminal, la commande n’affiche pas d’invite : elle se termine avec une indication. Avec CI=true, la connexion par navigateur refuse de s’exécuter. Consultez CI et scripts.

​
squarecloud auth whoami

Utilisation
Affiche le compte avec lequel vous êtes connecté, son plan et le nombre de jours restants avant l’expiration du plan. Pour une clé émise par la connexion via le navigateur, la commande affiche aussi la date d’expiration de la clé et ses scopes ; lorsque la clé provient de SQUARECLOUD_API_KEY, elle l’indique à la place.
Sortie
Avec --json, la commande affiche le compte (ID, nom, e-mail, langue, plan et date de création) au format JSON.

​
squarecloud auth logout

Utilisation
Supprime la clé API enregistrée de cette machine. La clé n’est pas révoquée : pour cela, supprimez-la dans le tableau de bord. Lorsque SQUARECLOUD_API_KEY est définie, les commandes continuent de l’utiliser après une déconnexion.
Sortie
Si aucun compte n’est connecté, la commande affiche No account is connected on this machine. et se termine avec le code 0.

​
CI et scripts

En CI, ne vous connectez pas du tout : créez une clé API dans le tableau de bord et définissez-la dans la variable d’environnement SQUARECLOUD_API_KEY. Chaque commande l’utilise à la place de la clé enregistrée, et la CLI fonctionne même sur les machines sans dossier personnel.
  • Sans terminal, auth login ne demande rien : la commande se termine avec une indication. Utilisez --with-token, --token ou SQUARECLOUD_API_KEY.
  • Avec CI=true, la connexion par navigateur refuse de s’exécuter, car sa clé expire au bout de 90 jours et seule une personne peut la renouveler.
Plus de détails sur les codes de sortie et la sortie JSON dans Options globales et CI.

​
Quand la clé ne fonctionne plus

Si une commande indique que votre session a expiré ou que la clé API a été révoquée, exécutez à nouveau squarecloud auth login. Les commandes qui nécessitent un compte affichent You need to be logged in to run this command. et se terminent avec le code 1 lorsqu’aucune clé n’est enregistrée ni définie.

​
Voir aussi