Skip to content
OpenBot Docs

CLI Reference

The openbot CLI is the primary tool for managing your local agent server.

Installation

Section titled “Installation”

Install the CLI globally using npm:

Terminal window
npm i -g openbot

Commands

Section titled “Commands”

openbot start

Section titled “openbot start”

Starts the OpenBot agent server.

  • Options:
    • --port <number>: Specify the port to listen on (default: 4132).
    • --baseDir <path>: Specify the base directory for OpenBot data (default: ~/.openbot).
Terminal window
openbot start --port 3000

openbot help

Section titled “openbot help”

Displays help information for the CLI or a specific command.

Terminal window
openbot help start

Environment Variables

Section titled “Environment Variables”

OpenBot reads variables from ~/.openbot/variables.json. These are applied to the server process environment on startup. This is the recommended place to store API keys and other secrets.

Example variables.json:

{
  "OPENAI_API_KEY": "your-key-here",
  "ANTHROPIC_API_KEY": "your-key-here"
}