CLI Overview
Manage tools, knowledge, toolsets, prompts, and MCP connections from your terminal
The Protobox CLI manages your workspace from the command line — create tools and toolsets, ingest knowledge, manage prompts, and connect AI clients via MCP.
Install
npm install -g @protoboxai/cliVerify:
protobox --versionAuthenticate
protobox loginOpening browser for authentication...
✓ Authentication successful
User: dean@acme.com
Workspace: ws_abc123Or use an API key directly (best for CI and scripts):
protobox login --api-key YOUR_API_KEYCheck status:
protobox auth statusCommand Map
Commands
Build
| Command | Description |
|---|---|
protobox tools list | List all tools in the workspace |
protobox tools create -f <file> | Create a tool from a JSON definition |
protobox tools get <id> | Get tool details |
protobox tools execute <id> -i '{...}' | Execute a tool with arguments |
protobox tools delete <id> | Delete a tool |
protobox toolsets list | List toolsets |
protobox toolsets create -f <file> | Create a toolset |
protobox toolsets get <id> | Get toolset details and tools |
protobox toolsets add-tools <id> -t <ids> | Add tools to a toolset |
protobox toolsets remove-tools <id> -t <ids> | Remove tools from a toolset |
protobox kb add | Add a knowledge entry (text, URL, or file) |
protobox kb search <query> | Search the knowledge base |
protobox kb list | List knowledge entries |
protobox prompts list | List prompt templates |
protobox prompts create -f <file> | Create a prompt |
Connect
| Command | Description |
|---|---|
protobox mcp config | Generate MCP config for Claude / Cursor |
protobox mcp test | Run an MCP protocol test |
protobox mcp install --format <client> | Generate a config snippet for an editor |
protobox chat <agent-id> | Interactive text chat with your assistant |
protobox chat <agent-id> -m "..." | Send a single message |
Core
| Command | Description |
|---|---|
protobox login | Authenticate via browser, or --api-key |
protobox auth status | Show current user and workspace |
protobox logout | Clear stored credentials |
protobox config set <key> <value> | Set a config value |
protobox config list | Show all config |
protobox workspaces list | List your workspaces |
protobox workspaces use <id> | Set the active workspace |
protobox health | Check API status |
See the Command Reference for every flag.
Configuration
protobox config set workspaceId ws_abc123
protobox config set defaultFormat json
protobox config listConfig lives in ~/.protobox/config.json. See Configuration & Secrets for details.
Environment Variables
Override config with environment variables (handy for CI):
export PROTOBOX_API_KEY=YOUR_API_KEY
export PROTOBOX_WORKSPACE_ID=ws_abc123Global Options
| Option | Description |
|---|---|
--json | Output results as JSON |
--no-color | Disable colored output |
-v, --version | Print CLI version |
-h, --help | Show help for any command |
Output Formats
Table output (default) for humans:
protobox tools listJSON output for scripts:
protobox tools list --json | jq -r '.tools[].id'Scripting
# Enable every disabled HTTP tool
protobox tools list --type http --disabled --json | \
jq -r '.tools[].id' | \
xargs -I {} protobox tools enable {}CI/CD
- name: Sync tools
run: protobox tools list --json > tools.json
env:
PROTOBOX_API_KEY: ${{ secrets.PROTOBOX_API_KEY }}
PROTOBOX_WORKSPACE_ID: ${{ vars.PROTOBOX_WORKSPACE_ID }}