Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ironbee.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Requirements

  • Node.js 22 or later
Check your version: 
node --version

​
Install

npm install -g @ironbee-ai/cli
Verify the installation succeeded: 
ironbee --version

​
Supported AI clients

The CLI works with:
ClientInstall detects automatically
Claude CodeYes
CursorYes
When you run ironbee install in a project, IronBee reads your environment and writes the correct hook and MCP configuration for your client. You can also specify the client explicitly: 
ironbee install --client claude
ironbee install --client cursor

​
Update

To update to the latest version: 
npm update -g @ironbee-ai/cli

​
Uninstall

To remove the CLI from your machine: 
npm uninstall -g @ironbee-ai/cli
To also remove IronBee configuration from a project: 
ironbee uninstall

​
Log in

After installing, connect the CLI to your IronBee account: 
ironbee login
This opens your browser, completes the OAuth flow, and writes your API key and collector URL to ~/.ironbee/config.json. You only need to do this once per machine.

​
Next step

Set up your project

Run ironbee install to configure hooks and MCP servers for your AI client.