Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Authentication (CLI)

Login with an API key

  1. Create an API key in the web UI at Settings > API Keys
  2. Run:
ssynth login --api-key sk_live_YOUR_KEY

Or omit the flag to be prompted:

ssynth login
# API Key: (paste key, hidden)

On success, the key is stored in ~/.config/ssynth/config.toml and your default tenant is set automatically.

Environment variable

Skip the config file entirely:

export SSYNTH_API_KEY=sk_live_YOUR_KEY
ssynth targets

The environment variable takes priority over the config file.

Verify

ssynth config show   # shows stored auth and tenant
ssynth targets       # quick smoke test

Dev login (local development only)

When the API has DEV_AUTH_BYPASS=true:

ssynth login --dev --username myname

This uses a short-lived JWT instead of an API key. Not available in production.