Docs · CLI
Beehaven CLI
Beehaven is the command-line interface to your Clearly agent cloud — one command line for every agent and workspace you own. You connect to a target, then run actions, manage memory, and query state against it. This page is the command reference.
Install & access
Beehaven ships with Clearly. Sign in and the CLI is set up for your account — it mints a local auth token and connects to the relay automatically, so you never manage tokens by hand. Broader standalone distribution is rolling out; create an account to get access.
# verify the CLI can reach your cloud beehaven status # → Account: Connected
Connect to a target
Everything you address is a durable object. Connect once to set the active target; every subsequent command auto-routes to it. There are three address shapes:
beehaven connect home # your personal workspace beehaven connect team/<id> # a team's agent cloud beehaven connect <appName> # a locally installed app
Call actions
List what a target can do, then call an action with an optional JSON payload:
beehaven actions
beehaven call send-digest '{"to":"ops","range":"24h"}'
# → { ok: true, delivered: 1 }Give agents memory
remember and recall are the substrate behind your company brain. Memories are stored as vectors and retrieved by meaning, not exact keywords:
beehaven call context-write '{"title":"Refund policy","body":"Refunds: 30 days, minus shipping."}'
beehaven call context-search '{"query":"refund window"}'
# → Refund policy - Refunds: 30 days, minus shipping.Drive the canvas
canvas-invoke reaches into an open Vector Studio tab and runs a registered action — paste a URL, re-trace, export a bundle. The tab must be open; the CLI drives it, it doesn't spawn it.
beehaven call canvas-invoke '{"action":"vector.export-bundle"}'
# → { ok: true }Command reference
| Command | What it does |
|---|---|
| beehaven connect <addr> | Set the active target. Address grammar: home · <type>/<id> · <appName>. |
| beehaven call <action> [json] | Run an action against the connected target, one-shot. |
| beehaven actions | List the actions the connected target exposes. |
| beehaven call context-write {json} | Write a doc / decision into the company brain. |
| beehaven call context-search {json} | Search the brain by meaning - prompts, docs, decisions, facts. |
| beehaven ls · cat · grep · tree | Inspect the connected workspace like a filesystem. |
| beehaven sql <query> | Query the target’s state store directly. |
| beehaven watch | Stream live events from the connected target. |
| beehaven status | Show connection + auth state. |
| beehaven login · logout · whoami | Account management. |
| beehaven disconnect | Clear the active target. |
How it routes
A local daemon keeps a secure connection to the Clearly relay and routes every command to the right durable object. Only one daemon runs at a time; it handles auth and the WebSocket so the CLI stays a thin, scriptable front end an agent can shell out to. That's what makes Beehaven software for agents and not just another dashboard.