Skip to main content
The CLI signs in with your Olostep account, the same account you use on the dashboard. You don’t need to paste an API key. Most commands need you to be signed in. --help, olostep help, and olostep feedback don’t.

​
Sign in

Your browser opens the Olostep sign-in page. Sign in, and the CLI saves the sign-in on this computer. You stay signed in until you run olostep logout. If you run a command that needs sign-in before you have signed in, the CLI shows Please sign in to Olostep to continue. with two choices, Sign in and Exit. Choose Sign in to open the browser; the command continues after you sign in.

​
Check who you are

Prints your account, your team, the team’s plan and its credit balance. olostep whoami is the same command as olostep account info.

​
Sign out

Olostep revokes this computer’s connection, and the CLI forgets the saved sign-in. Other computers stay signed in.

​
Scripts, CI and agents

A script or CI job can’t complete a browser sign-in. Give it a token instead, with the OLOSTEP_TOKEN environment variable or the --token flag on any command:
A token in OLOSTEP_TOKEN or --token is used instead of the saved sign-in. When a command that needs sign-in runs without a terminal, or from a coding agent, and there is no sign-in or token, the CLI does not prompt. It prints this to stderr and exits with code 3:
Check for exit code 3 in scripts:
See Exit codes for every code.

​
Where the sign-in is stored

The CLI keeps its sign-in in ~/.config/olostep (or $XDG_CONFIG_HOME/olostep if you set XDG_CONFIG_HOME). The folder is readable only by your user.

​
API keys

The CLI does not need an API key. Your code that calls the Olostep API does. To put one of your keys into a .env file without printing it:
This writes OLOSTEP_API_KEY=... to .env. See olostep keys reveal.