Skip to content

yasp-toolkit login

Create an API key by approving this device in the browser, and store it in the keyring slot keyring set writes.

Usage:

$ yasp-toolkit login [OPTIONS]
Option Default Description
--name <str> — Names the key on the dashboard. Default: this host's name.
--browser / --no-browser browser Open the approval URL in a browser; it is printed either way.
$ yasp-toolkit login
Open https://compile.yasp.ai/login-cli/approve?device_selector=… and enter the code ABC-DEF
Logged in to team Acme. API key CLI: <my-laptop> 2026-10-16 12:00:00 UTC stored for https://compile.yasp.ai/api.
  • The URL is printed before the browser opens; open it on any device when no browser starts (--no-browser on SSH or headless hosts).
  • In the browser: log in, pick a team, check the code against the terminal (the browser login opens has it filled in; the printed URL does not) and approve. The key is named CLI: <name> YYYY-MM-DD HH:MM:SS UTC on the dashboard, <name> being --name or the hostname, brackets included.
  • The browser page shows the device name, IP address and start time. Select Deny if you didn't start the login: login then stops with "The login was denied in the browser."
  • The request expires after 10 minutes, after 3 wrong codes, or when it is denied; run login again.
  • YASP_API_KEY overrides the keyring; login warns when it is set.
  • No OS keyring backend: the key is stored unencrypted in ~/.local/share/python_keyring/keyring_pass.cfg (mode 0600), with a warning naming the file.
  • Keyring disabled (PYTHON_KEYRING_BACKEND=keyring.backends.fail.Keyring): the key is printed once as export YASP_API_KEY=… with a warning, exit 0. The server never returns it again.