Skip to main content
Configure global Codaph settings including Mubit API key and actor identity.

​
Usage

codaph setup [options]

​
Description

The setup command configures global Codaph settings stored in ~/.codaph/settings.json. This is typically run once after installing Codaph. After setup, run codaph init inside each project to enable per-repo features.

​
Flags

​
--mubit-api-key
string
Mubit API key for cloud syncGet your key from console.mubit.ai
​
--mubit-actor-id
string
Actor/user identifier for Mubit eventsAuto-detected from GitHub CLI or git config if not provided
​
--openai-api-key
string
OpenAI API key for agent-assisted queriesOptional; enables AI chat in TUI
​
--yes
boolean
default:"false"
Auto-detect and save actor ID without prompting
​
--json
boolean
default:"false"
Output JSON instead of human-readable text

​
Examples

​
Basic Setup

codaph setup --mubit-api-key mb_live_abc123...

​
Setup with Actor ID

codaph setup \
  --mubit-api-key mb_live_abc123... \
  --mubit-actor-id your-github-username

​
Setup with OpenAI

codaph setup \
  --mubit-api-key mb_live_abc123... \
  --openai-api-key sk-proj-...

​
Auto-detect Actor

codaph setup --mubit-api-key mb_live_abc123... --yes
Auto-detects actor ID from:
  1. GitHub CLI (gh api user)
  2. Git config (git config user.name)
  3. Shell user ($USER)

​
Output

$ codaph setup --mubit-api-key mb_live_abc123...

Codaph setup (global)
Config: ~/.codaph/settings.json
Mubit: ✓ configured | actor=alice
OpenAI agent: off
ℹ Next Run `codaph init` inside a repo to create `.codaph/` and enable repo automation.

​
JSON Output

codaph setup --mubit-api-key mb_live_abc123... --json

{
  "changed": true,
  "globalConfigPath": "~/.codaph/settings.json",
  "mubit": {
    "configured": true,
    "actorId": "alice"
  },
  "openai": {
    "configured": false
  },
  "next": {
    "init": "codaph init"
  }
}

​
Files Modified

  • ~/.codaph/settings.json - Global settings file

​
Next Steps

After global setup:
  1. Navigate to a project directory
  2. Run codaph init to initialize the project
  3. Run codaph pull to sync cloud activity
  4. Run codaph tui to browse sessions

Build docs developers (and LLMs) love

Get started for freeTalk to us