CLI Authentication
The CLI uses a Public API key (verlynk_...), not an MCP token.
note
MCP tokens are for AI integrations. Create those under Create MCP Token. For the CLI, create a Public API key in Settings → Developer on verlynk.com, or with verlynk keys:create.
Option 1: Stored credentials (recommended)
verlynk auth:login --key verlynk_your_key_here
Optionally set a default profile at login:
verlynk auth:login --key verlynk_your_key_here --profile-id <profile-uuid>
You can omit --key to enter the key interactively (masked stdin prompt).
Optional flags:
| Flag | Description |
|---|---|
--key | Public API key (verlynk_...) |
--api-url | Custom API base URL |
--profile-id | Default profile UUID to save |
Credentials are saved to:
- Windows:
%USERPROFILE%\.verlynk\credentials.json - macOS / Linux:
~/.verlynk/credentials.json
verlynk auth:status
verlynk auth:logout
Option 2: Environment variables
export VERLYNK_API_KEY=verlynk_your_key_here
# optional
export VERLYNK_API_URL=https://verlynk.com/api
export VERLYNK_PROFILE_ID=<profile-uuid>
| Variable | Required | Default | Description |
|---|---|---|---|
VERLYNK_API_KEY | No* | — | Public API key (verlynk_...) |
VERLYNK_API_URL | No | https://verlynk.com/api | Custom API base URL |
VERLYNK_PROFILE_ID | No | — | Default profile UUID |
*Either verlynk auth:login or VERLYNK_API_KEY is required.
warning
Stored credentials from auth:login take priority when both stored credentials and environment variables are present.
Security
warning
- Never commit API keys to git.
- Rotate keys if exposed.
- Prefer environment variables or a secrets manager in CI.