Skip to main content
The Bitfab CLI installs the plugin, authenticates, and launches setup for Claude Code, Codex, or Cursor in one command.

Quick Start

npx bitfab-cli init
This runs the full onboarding flow:
  1. Detects which editors you have installed
  2. Installs the Bitfab plugin in your chosen editor
  3. Authenticates via browser-based OAuth
  4. Launches the setup command (/bitfab:setup) in your editor
If multiple editors are detected, you’ll be prompted to choose one. To skip the prompt, pass --editor:
npx bitfab-cli init --editor claude
npx bitfab-cli init --editor codex
npx bitfab-cli init --editor cursor

Commands

init

Full onboarding: install the plugin, authenticate, and launch setup.
npx bitfab-cli init [--editor <name>]

plugin-install

Install the Bitfab plugin without authenticating or launching setup. Useful if you want to handle login separately.
npx bitfab-cli plugin-install [--editor <name>]

login

Authenticate with Bitfab. Opens your browser for OAuth, then saves credentials to ~/.config/bitfab/credentials.json.
npx bitfab-cli login

logout

Remove stored credentials.
npx bitfab-cli logout

setup

Launch the editor’s setup command (/bitfab:setup for Claude Code, $bitfab:setup for Codex) without reinstalling the plugin. For Cursor, prints the setup command and next steps.
npx bitfab-cli setup [--editor <name>]

assistant

Launch the Bitfab assistant (/bitfab:assistant for Claude Code, $bitfab:assistant for Codex) to iterate on traced functions. Any extra arguments are passed through to the editor command.
npx bitfab-cli assistant [--editor <name>] [args...]

update

Update the Bitfab plugin and SDKs. The CLI refreshes the plugin directly (marketplace update + plugin update), then launches the editor’s update command for SDK updates. Pass plugin, sdk, or all to control scope.
npx bitfab-cli update [--editor <name>] [plugin | sdk | all]

Flags

--editor, -e

Target a specific editor (claude, codex, or cursor). If omitted, the CLI detects installed editors and prompts you to choose.

--skip-permissions

Run the launched agent without permission prompts (translates to --dangerously-skip-permissions for Claude Code, --full-auto for Codex). If you omit this flag, the CLI will ask interactively whether to skip permissions. Pass --no-skip-permissions to keep permission prompts without being asked. Applies to: init, setup, assistant, update.

What It Does Per Editor

Claude Code

  • Adds the bitfab marketplace (from Project-White-Rabbit/bitfab-claude-plugin)
  • Enables auto-updates for the marketplace
  • Installs the plugin at user scope
  • Launches claude /bitfab:setup

Codex

  • Adds the bitfab marketplace (from Project-White-Rabbit/bitfab-codex-plugin)
  • Enables the plugin in ~/.codex/config.toml
  • Launches codex $bitfab:setup

Cursor

  • Copies the /add-plugin command to your clipboard
  • Opens Cursor so you can paste and run the command
  • Prints next steps for completing setup in Cursor

Requirements

  • Node.js 18+
  • At least one supported editor installed: claude, codex, or cursor must be on your PATH