Skip to content

Authentication ​

lindris authenticates to the Lindris API with an API key. Generate one in the Lindris dashboard under Account → API, then sign in once:

bash
lindris auth login

lindris prompts for the key and stores it in your OS keyring — Keychain on macOS, secret-service on Linux, Credential Manager on Windows. The key is never written to disk in plaintext.

Where your key comes from ​

lindris resolves the active API key from two sources, in order:

  1. OS keyring (recommended) — populated by lindris auth login. This is the default on a developer machine.
  2. LINDRIS_API_KEY environment variable (fallback) — used automatically when the keyring is empty for the active account, or when the keyring can't be reached (a locked gnome-keyring session, a CI container, Docker). No auth login needed — just set the variable.

Check which source resolved the active key at any time:

bash
lindris auth status

lindris doctor reports the same as part of a broader health check — run it first whenever a call unexpectedly returns 401.

Multiple accounts: profiles ​

Working across more than one Lindris account? Give each its own profile — a named keyring entry — and switch between them. The active profile is persisted to your config file, so every later command uses its key.

Adding a profile also resolves which account that key belongs to and records it, so lindris auth profile show <name> can say whose account a key opens. If the API can't be reached at that moment the key is still stored and the account is recorded the next time a profile verb reaches it.

bash
# store the key for a new profile (reads $LINDRIS_API_KEY)
LINDRIS_API_KEY=<your-key> lindris auth profile add work --with-token

# switch the active profile — later commands use its key
lindris auth profile use work

auth profile add prompts for the key exactly as auth login does — masked on a terminal — so you can run it bare and paste. It also accepts the key piped on stdin, or from $LINDRIS_API_KEY with --with-token, so profile setup can be scripted. The rest of the family:

bash
lindris auth profile list      # list configured profiles
lindris auth profile show      # metadata for a profile (key redacted)
lindris auth profile remove    # delete a profile's keyring entry

CI and headless environments ​

Where no keyring is available — CI runners, Docker images, headless servers — skip auth login entirely and set LINDRIS_API_KEY:

bash
export LINDRIS_API_KEY="<your-key>"
lindris people list

lindris falls back to the variable automatically. Quote the key — a Lindris API key can contain a |, which an unquoted value lets the shell read as a pipe and corrupt the key.

Signing out ​

bash
lindris auth logout

Removes the stored API key from the keyring.

Where to next ​