BeakrGo to website
Docs/Developer Guide/Authentication

Authentication

Authenticate with your Beakr API key to access your knowledge base from the CLI and MCP server.

Get your API key

  1. Open thebeakr.com and sign in.
  2. Go to Settings (bottom of the left sidebar).
  3. Select the API Keys tab.
  4. Click Create API Key, give it a name, and copy the key.

The key starts with bk_live_ and is shown only once at creation. Store it somewhere safe.

Login

beakr auth login

Paste your API key when prompted. After successful authentication, the CLI will ask you to select a default project scope.

Sandbox environment

beakr auth login --env sandbox

Custom API URL

beakr auth login --api-url https://your-instance.example.com

Check identity

beakr auth whoami

Shows your current user, organization, and project scope.

Change project scope

beakr auth set-scope

Opens an interactive picker to select a default project. All subsequent commands will be scoped to this project unless overridden with --project.

Local development

For local development against a running Beakr API, use dev mode instead of API key authentication:

beakr auth dev \
  --identity seed_sarah \
  --email sarah.chen@example.com \
  --name "Sarah Chen" \
  --api-url http://localhost:8000

Dev mode uses identity headers (X-Identity-Id, X-Email) instead of bearer tokens.

Logout

beakr auth logout

Removes all stored credentials and project scope.