Guidal
Sign in

CLI install and authenticate

Install the guidal command line tool and sign in.

The guidal CLI drives everything the platform does. It is a Python package and works on macOS, Linux and Windows.

Install

bash
pip install guidal

Verify:

bash
guidal version

If guidal is not found after installing, your Python scripts directory is not on your PATH. python -m pip show guidal prints the install location, whose bin (or Scripts on Windows) directory needs to be on PATH.

Upgrade

bash
pip install --upgrade guidal

Sign in

bash
guidal login

This opens your browser to complete authentication and stores a token locally. Confirm it worked:

bash
guidal whoami
guidal auth status

Sign out when you are done on a shared machine:

bash
guidal logout

Set your working context

Commands operate on a project inside an organization. Rather than passing --org and --project every time, select them once:

bash
guidal orgs list
guidal orgs switch my-org
guidal projects list
guidal projects switch my-app

Any command still accepts explicit flags, which override the stored context — useful in scripts that touch several projects.

Authenticating without a browser

CI and other unattended environments cannot complete a browser login. Use an API key instead, exported as an environment variable:

bash
export GUIDAL_ACCESS_TOKEN="<your-api-key>"
guidal services list

When that variable is set, the CLI uses it and does not attempt an interactive login. See API keys for creating and scoping keys.

This is also the fix for credential prompts in scripts

A script that shells out to guidal without GUIDAL_ACCESS_TOKEN set may trigger an interactive credential prompt on some systems. Exporting the variable before the first invocation avoids it entirely.

Getting help

Every command documents itself:

bash
guidal --help
guidal services --help
guidal services create --help

Next