Passer au contenu principal
Le CLI se connecte avec votre compte Olostep, le même compte que vous utilisez sur le tableau de bord. Vous n’avez pas besoin de coller une clé API. La plupart des commandes nécessitent que vous soyez connecté. --help, olostep help et olostep feedback n’en ont pas besoin.

Se connecter

Votre navigateur ouvre la page de connexion Olostep. Connectez-vous, et le CLI enregistre la connexion sur cet ordinateur. Vous restez connecté jusqu’à ce que vous exécutiez olostep logout. Si vous exécutez une commande nécessitant une connexion avant de vous être connecté, le CLI affiche Veuillez vous connecter à Olostep pour continuer. avec deux choix, Se connecter et Quitter. Choisissez Se connecter pour ouvrir le navigateur ; la commande continue après votre connexion.

Vérifiez qui vous êtes

Affiche votre compte, votre équipe, le plan de l’équipe et son solde de crédit. olostep whoami est la même commande que olostep account info.

Se déconnecter

Olostep révoque la connexion de cet ordinateur, et le CLI oublie la connexion enregistrée. Les autres ordinateurs restent connectés.

Scripts, CI et agents

Un script ou un travail CI ne peut pas compléter une connexion via le navigateur. Donnez-lui un jeton à la place, avec la variable d’environnement OLOSTEP_TOKEN ou l’option --token sur n’importe quelle commande :
Un jeton dans OLOSTEP_TOKEN ou --token est utilisé à la place de la connexion enregistrée. Lorsqu’une commande nécessitant une connexion s’exécute sans terminal, ou depuis un agent de codage, et qu’il n’y a pas de connexion ou de jeton, le CLI ne demande pas. Il imprime ceci sur stderr et se termine avec le code 3 :
Vérifiez le code de sortie 3 dans les scripts :
Voir Codes de sortie pour chaque code.

Où la connexion est stockée

Le CLI conserve sa connexion dans ~/.config/olostep (ou $XDG_CONFIG_HOME/olostep si vous définissez XDG_CONFIG_HOME). Le dossier est lisible uniquement par votre utilisateur.

Clés API

Le CLI n’a pas besoin d’une clé API. Votre code qui appelle l’API Olostep en a besoin. Pour mettre l’une de vos clés dans un fichier .env sans l’imprimer :
Cela écrit OLOSTEP_API_KEY=... dans .env. Voir olostep keys reveal.