Configuration
Configuration options for the Beakr CLI and MCP server.
Config file
Credentials and scope are stored in ~/.beakr/config.json. This file is created automatically by beakr auth login.
| Key | Description |
|---|---|
api_key | Bearer token for API authentication |
api_url | API base URL (default: https://api.thebeakr.com) |
project_id | Default project scope |
dev_identity_id | Dev mode identity ID |
dev_email | Dev mode email |
dev_display_name | Dev mode display name |
Environment variables
Environment variables override config file values. Useful for CI/CD and MCP server configuration.
| Variable | Description |
|---|---|
BEAKR_API_KEY | API bearer token |
BEAKR_API_URL | API base URL |
BEAKR_PROJECT_ID | Default project scope |
BEAKR_DEV_IDENTITY | Dev identity ID |
BEAKR_DEV_EMAIL | Dev email |
BEAKR_DEV_DISPLAY_NAME | Dev display name |
Priority order
When resolving configuration values, the CLI checks in this order:
- Per-command flags (
--project, etc.) - Environment variables (
BEAKR_*) - Config file (
~/.beakr/config.json) - Defaults (org-wide scope, production API URL)
Page resolution
When a command accepts a page argument, the CLI resolves it flexibly:
- UUID (exact match)
- Slug (exact match)
- Title (search)
This means you can reference pages by any identifier: beakr kb cat "Project Overview" works the same as beakr kb cat project-overview.