Authentication

Getting an API Key

Get your API key from platform.pretorin.com.

Beta Note: Framework and control browsing works for authenticated users. Platform write features (evidence, narratives, monitoring) require a beta code. Systems can only be created on the platform, not through the CLI or MCP. Sign up for early access.

All hosted API access is account-scoped and authenticated. Access to Pretorin-hosted services and any returned account-scoped data is governed by the applicable platform terms in addition to the open-source license for this repository.

Login

pretorin login

Options:

You’ll be prompted to enter your API key. Credentials are stored in ~/.pretorin/config.json.

If you’re already authenticated, pretorin login validates your existing key against the API and skips the prompt. To re-authenticate with a different key, pass it explicitly:

pretorin login --api-key <new-key>

If you log into a different API endpoint or switch API keys, Pretorin clears the stored active system + framework context so stale scope does not bleed into the new environment.

Verify Authentication

$ pretorin whoami
╭──────────────────────────────── Your Session ────────────────────────────────╮
│ Status: Authenticated                                                        │
│ API Key: pretorin...9v7o                                                     │
│ API URL: https://platform.pretorin.com/api/v1/public                         │
│ Frameworks Available: 26                                                     │
╰──────────────────────────────────────────────────────────────────────────────╯

For machine-readable output, use the global --json flag:

pretorin --json whoami

Logout

Clear stored credentials:

pretorin logout

Environment Variables

You can supply credentials via environment variables instead of pretorin login. Environment variables take precedence over stored config:

export PRETORIN_API_KEY=pretorin_your_key_here

# Optional — point at a self-hosted or local platform instead of the default.
# This is the env-var equivalent of `pretorin login --api-url`.
export PRETORIN_PLATFORM_API_BASE_URL=https://platform.example.com/api/v1/public

This is useful for CI/CD pipelines and containerized environments.

PRETORIN_API_BASE_URL is accepted as a legacy alias for PRETORIN_PLATFORM_API_BASE_URL; when both are set, the platform-prefixed name wins. See Environment Variables for the full list.