Skip to main content
Codaph recognizes several environment variables for configuration. These can be overridden by CLI flags or saved settings.

​
Mubit Configuration

​
MUBIT_API_KEY
string
Primary Mubit API key variableEnables Mubit cloud sync and shared memory features. Get your key from console.mubit.ai.Alternative: MUBIT_APIKEY (deprecated but supported)Can be overridden by:
  • --mubit-api-key flag
  • ~/.codaph/settings.json global config
​
CODAPH_PROJECT_ID
string
Override project ID for MubitAlternative: MUBIT_PROJECT_IDAuto-detected from git remote (owner/repo) if not set.
​
CODAPH_ACTOR_ID
string
Actor/user identifier for Mubit eventsAuto-detected from:
  1. GitHub CLI (gh api user)
  2. Git config (user.name)
  3. Shell user ($USER or $USERNAME)
​
CODAPH_MUBIT_RUN_SCOPE
string
Mubit run scope: project or session
  • project (default when project ID available) - Shared run across contributors
  • session - Separate run per captured session

​
OpenAI Configuration

​
OPENAI_API_KEY
string
OpenAI API key for agent-assisted queries in TUI chatAlternative: OPENAI_APIKEY (deprecated but supported)Can be overridden by:
  • --openai-api-key flag
  • ~/.codaph/settings.json global config
​
OPENAI_MODEL
string
default:"gpt-4.1-mini"
OpenAI model for agent queriesCan be overridden by --openai-model flag

​
Advanced Mubit Options

​
--mubit-endpoint
string
Custom Mubit API endpoint (for enterprise deployments)
​
--mubit-http-endpoint
string
Force HTTP transport endpoint
​
--mubit-grpc-endpoint
string
Force gRPC transport endpoint
​
--mubit-transport
string
Transport mode: auto, http, or grpcDefault: auto (selects based on availability)
​
--mubit-write-timeout-ms
number
default:"15000"
Write timeout in milliseconds for Mubit operations
​
--mubit-agent-id
string
default:"codaph-cli"
Agent identifier for Mubit events

​
Shell Variables

​
USER
string
Fallback for actor ID if not otherwise configured (Unix/Linux)
​
USERNAME
string
Fallback for actor ID if not otherwise configured (Windows)

​
Version Detection

​
npm_package_version
string
Used to detect CLI version when run via npm/bun scripts

​
Configuration Priority

For most settings, Codaph resolves values in this order (highest priority first):
  1. CLI flags (e.g., --mubit-api-key)
  2. Environment variables (e.g., MUBIT_API_KEY)
  3. Saved settings (~/.codaph/settings.json or .codaph/project.json)
  4. Auto-detection (e.g., from git/GitHub)
  5. Built-in defaults

​
Example Setup

~/.bashrc or ~/.zshrc
# Mubit cloud sync
export MUBIT_API_KEY="mb_live_abc123..."
export CODAPH_ACTOR_ID="your-github-username"

# Optional: OpenAI for TUI chat
export OPENAI_API_KEY="sk-..."
Check effective configuration
codaph doctor

Build docs developers (and LLMs) love

Get started for freeTalk to us