livehuddle is a command line for the livehuddle API. It is built first for coding agents (an agent working in your repository, or one changing a board while you talk to it) and second for scripts: finding spaces, reading a tab as text, changing it with edit operations, answering comments, and syncing spaces to files.
It sits beside the MCP server, not in place of it. Both call the same API with an API token, and the API owns every change, so an older copy of the CLI never writes the old way.
Install
The CLI is the npm package @livehuddle/cli and needs Node 22 or later. Run it without installing:
npx @livehuddle/cli --help
or install it, which gives you the livehuddle command:
npm install -g @livehuddle/cli
livehuddle --version
The examples below use the installed livehuddle; with npx, put npx @livehuddle/cli in its place.
Sign In
You need a livehuddle account: the CLI acts as you, through an API token, and never as a guest. There are three ways to give it one. Whichever you use, the CLI checks the token with the API before keeping it.
In the Browser
livehuddle auth login
The CLI opens a sign-in page in your browser (and prints its address, in case the browser does not open). Sign in if you are not already, and you reach an approval card, Connect livehuddle CLI. Leave Read-only access off to let the CLI change spaces, or switch it on so it can find and view spaces but not create, edit, delete or share them. The card also says where the access goes: your own computer, 127.0.0.1 and a port number. Choose Connect, and the page says You're signed in: return to your terminal.
The terminal waits up to ten minutes for you. If the browser cannot reach it (on a remote machine, say), use a device code instead.
On a Machine Without a Browser
livehuddle auth login --device
The terminal prints a page address, https://livehuddle.app/oauth/device, and a code of eight letters such as BCDF-GHJK, plus a link with the code already filled in. Open the page on any device, sign in, type the code under Code shown in your terminal and choose Continue. You then see a Connect livehuddle CLI card with the same Read-only access switch; choose Connect, and the page says You're connected. The terminal carries on by itself.
A code lasts ten minutes. If the page says it couldn't find the code, check it and try again; if it has expired, run the command again for a new one. Choosing Cancel on the page stops the terminal waiting. Only enter a code that a terminal you are using is showing you.
With an API Token
For CI, sandboxes and agents, create a token on liveworkspace.app, and either set it for the commands you run:
export LIVEHUDDLE_TOKEN=lwt_your_token_here
or store it for this machine, reading it from stdin:
printf %s "$TOKEN" | livehuddle auth login --with-token
LIVEHUDDLE_TOKEN takes precedence over a stored sign-in. There is deliberately no --token flag, because a token on the command line ends up in shell history and transcripts.
Check or Sign Out
livehuddle auth status # host, account, token name, role, expiry, and where it came from
livehuddle auth logout # revoke the stored token and forget it
auth status never prints the token itself, and warns you when it has under 14 days left. auth logout revokes the token with livehuddle, so it stops working everywhere at once. It will not revoke a token from LIVEHUDDLE_TOKEN, which is not the CLI's to revoke: unset the variable, or revoke that token on liveworkspace.app.
The browser and device sign-ins create an ordinary API token named livehuddle CLI. It appears with your other tokens on liveworkspace.app (marked read-only if you chose that), lasts six months, and counts towards your 20. Signing in again on the same machine replaces it and revokes the old one.
Where Your Token Is Kept
A stored token goes in your operating system's own secret store: the macOS Keychain, the Secret Service on Linux (through secret-tool), or on Windows the token sealed to your user account by Windows' own data protection. Where that store is unavailable, the token is kept in ~/.config/livehuddle/credentials.json, readable only by you, and the CLI tells you so when it stores it there. If it finds that file readable by others, it tightens it and warns you.
Find and Read Spaces
Commands are a resource, then a verb. doc and el are short for document and element.
livehuddle document ls auth # documents whose name contains "auth"
livehuddle tab ls "Auth flow" # the document's tabs
livehuddle tab view "Auth flow" # the first tab, as an outline
livehuddle tab view "Auth flow" --tab Flow --view graph
livehuddle tab lint "Auth flow" # what is wrong with how it is drawn
livehuddle tab render "Auth flow" --png auth.png
document ls covers your personal library and every team you have joined, newest first. Wherever a command takes a space, you can give its name, the start of its id, or a pasted livehuddle link; a share link acts through that link. A name that matches more than one space is refused with the candidates, rather than guessed. --tab takes a tab name or the start of its id, and the first tab is used when you leave it out.
tab view reads a tab as text, the outline by default; --view picks graph, layout, comments, show (one element, with --ref) or find (with --text), and --budget fits it to about that many tokens. tab render writes a PNG or SVG preview and prints its path and size, never image bytes.
A few commands read livehuddle's catalogues rather than your spaces, which helps before writing anything:
livehuddle template ls # the templates a document or tab can start from
livehuddle template view retrospective # one template, as the outline of the tab it builds
livehuddle icon search "message queue" # icons by name, best match first, for iconId=
livehuddle schema sticky # the element kinds, or one kind's fields and values
Change a Space
livehuddle document create "Shop" -f arch.json # from a graph, Mermaid or elements file
livehuddle document create "Retro" --template start-stop-continue
livehuddle element set "Auth flow" n3 label="Sign in" shape=stadium
livehuddle edit "Auth flow" -f ops.txt # many edit operations at once
livehuddle changeset revert "Auth flow" cs_8k2m4q7d1x
livehuddle tab add "Auth flow" Details -f detail.mmd # a new tab, empty, from a file or --template
livehuddle tab rm "Auth flow" Scratch # delete one tab; the others stay
Every change is one changeset, applied all or nothing and checked against the version of the tab you last read, so the CLI never silently overwrites someone else's work. Each write prints what changed, the new revision, a lint summary and the command that reverts it. Add --dry-run to see the plan without writing anything, and --summary to say what the change is for. livehuddle guide edit explains how edit operations read.
document rm moves a space to the Trash for 30 days, and document restore brings it back to its folder (or the top level, when that folder is gone); the CLI has no permanent delete.
Comments and Waiting
livehuddle comment ls "Shop"
livehuddle comment add "Shop" api "Should this be idempotent?"
livehuddle wait "Shop" --for comment --timeout 600
livehuddle watch "Shop" # stream changes until you stop it
wait blocks until someone comments or the space changes (a burst of edits counts as one change), prints it and exits, which lets an agent respond to the people working beside it. Comments the CLI adds are yours.
Files, Exports and Pictures
livehuddle pull "Shop" --to docs --svg # docs/shop.livehuddle.json, plus an SVG per tab
livehuddle push docs/shop.livehuddle.json # send back each tab whose elements changed
livehuddle export --all --to backup --format json,svg,md
livehuddle graph lint flow.mmd # check a graph or Mermaid file before writing it
livehuddle graph render flow.mmd --png flow.png
To draw beside your agent inside a developer tool, see Spaces in Your Developer Tools.
pull writes the space in the format the editor imports, and never overwrites a file holding changes you have not pushed yet (add --force to drop them). push sends each changed tab as a changeset; a tab that changed on livehuddle since you pulled it is refused and named, so pull again. Only elements travel: each changed tab's elements are replaced by the file's, so an element you removed from the file is removed from the tab, and a tab the space lacks is created. Changes to a tab's name, theme or background are not sent (a tab a push creates goes up with its name), and no tab or space is ever deleted by a push. export --all writes every space you can read, for backups and docs. graph lint and graph render work on the file alone and send nothing.
Help, Guides and the Agent Skill
livehuddle --help # the resources and four starting commands
livehuddle tab --help # a resource's verbs
livehuddle tab view --help # usage, flags and examples
livehuddle guide # how-tos: build, edit, views, comments, collaborate, workbench
livehuddle skill install --to ~/.claude/skills
livehuddle skill print > SKILL.md
Help is kept short so an agent pays only for what it asks. skill install writes a SKILL.md that tells a coding agent when to reach for the CLI; without --to it lists the usual skills folders (such as ~/.claude/skills for Claude Code). skill print writes the same file to stdout, for agents that keep their skills somewhere else. livehuddle api GET /documents calls any API path with your sign-in, as an escape hatch.
Output and Exit Codes
The CLI never prompts, so it is safe in pipes, scripts and CI. stdout carries only data; hints, warnings and errors go to stderr. Output is compact text; --json gives the same data as JSON, --json=id,name picks fields, and -q prints only refs or ids. A list that was cut short ends with a line saying how to see the rest.
| Exit code | Meaning |
|---|---|
0 | Done |
1 | Refused: the input was understood but not accepted |
2 | Usage: the command line does not parse |
3 | Not found, or ambiguous: a space, tab or element |
4 | Not signed in, or not allowed (a read-only token's writes) |
5 | Conflict: the tab changed since you read it; read, retry |
6 | Rate limited |
7 | Network or server failure |
Every error names what was wrong and suggests one command that fixes it. Set LIVEHUDDLE_DEBUG=1 to see what the CLI is doing, on stderr.
Another Server
The CLI talks to https://livehuddle.app unless you point it elsewhere, for example at a local development server. For one command, add --host https://diagrams.example.com; for a shell, set LIVEHUDDLE_HOST. To keep several, name them as profiles in ~/.config/livehuddle/config.toml and choose one with --profile or LIVEHUDDLE_PROFILE:
default_profile = "work"
[profiles.work]
host = "https://diagrams.example.com"
Each profile keeps its own sign-in, and a profile for another host never contacts livehuddle.app. LIVEHUDDLE_TOKEN goes to whichever host is active, so set LIVEHUDDLE_HOST beside it. A server without accounts has no tokens, so the CLI cannot act there and says so; one without the sign-in server offers no browser or device sign-in, so use --with-token. If an instance needs a newer CLI for writes, the CLI refuses them and names the version to install.
Errors and Rate Limits
The CLI is subject to the same limits as any API client, per token: on the hosted service, 300 writes and 120 reads a minute. Over that, a command exits with 6 and asks you to wait a minute and retry. A read-only token's writes exit with 4. Errors and Rate Limits has the full list and the status codes behind these exit codes.
Usage Counts
The CLI counts which commands succeed, and which fail because of the server or the network, by the command's name only (never its arguments, your spaces or the host), and sends the count to the host it talks to, as anonymous telemetry. The first time it counts one, it says so. Turn it off with livehuddle telemetry off, LIVEHUDDLE_TELEMETRY=0 or DO_NOT_TRACK=1.
Keep It Safe
A full-access token can change and share everything you can. Give an agent a Read-only access
token when it only needs to read, keep LIVEHUDDLE_TOKEN out of source control and logs, and
revoke a token on liveworkspace.app (or with livehuddle auth logout) the moment you no longer
need it or think it may have leaked.
Was this article helpful?
Still need help?
Try Troubleshooting, or tell us what you were trying to do.