PhloemDocs
Markdown
Reference

phloem CLI

#Install

curl -fsSL https://dl.phloem.ai/cli/install.sh | sh

Then phloem login to sign in, and phloem update to stay current.

#Commands

statusWhat this device is and how it is doing
loginSign in to your Phloem account in the browser (or with --api-key in CI)
logoutSign out: revoke this machine's sign-in and forget it here
updateUpdate the CLI to the latest signed release (`--check` only says whether there is one)
whoamiWho the cloud says you are
deviceYour organization's devices: enrol a headless machine (an admin approves it), or remove one
runsYour organization's runs in the cloud, across every device
reservoirReservoir, your organization's data lake: read-only SQL over everything recorded
configA device's or a fleet's configuration, kept in the cloud and applied to the device
mcpConnect an AI coding tool (Claude Code, Cursor, Codex) to your organization's MCP server
timeEpoch-millisecond arithmetic: now, parse an instant, build a window
assetAssets: the equipment your data is about, and when each channel was about it
connectorCloud connectors (databases, ticketing, CAD…): list, add, run an operation, remove
sessionAsk Hamming, Phloem's agent, a question and print its answer
fieldRun fields: what an operator is asked for before a run's first step
doctorCheck this machine's setup; `--bundle DIR` writes a signed bundle for support
auditCompare what was captured with what reached the cloud, for a window (`--last 1h`, or `--from`/`--to`)
tailLive records as they arrive (a glob narrows: `tail 'ni/**'`)
peerLAN peers: discover, pair, approve and list other machines running Phloem
exportExport channels for a window (or a run) to a folder
importImport a recording file through its connector, attached to a named asset
applyApply a configuration document (YAML or JSON): connectors, then settings, then inputs
projectProjects on this machine: list, inspect, verify, create, switch, save, back up and restore
profileProfiles: published project versions in your organization's library
runRuns on this device: start and stop a manual run, list runs, show one
layoutHow the active project's screens are arranged: Live's and Replay's tabs and tiles
trellisTrellis: arm the stand with a test, run recipes, stop, reset and inspect
releaseSigned release files: load connectors onto a machine without internet
extensionConnectors installed on this machine: list, install, remove, reset
sourceThe active project's inputs, one at a time (`apply` sets them all from a document) [alias: input]
pipelineTemporary derived channels a tool adds to the pipeline (never saved into the project)
calCalibration records, and which channel each one applies to
functionThis device's function library: promote a function into it

#Global options

Accepted by every command.

--on <TARGET>Which machine's Phloem: `local` (default), or another machine's read address (`http://stand-b:8078`)
--via <ROUTE>How to reach a LAN peer (`--device`): `auto` (Phloem on this machine if it answers, else the CLI's own node), `daemon`, `node`
--api <URL>The cloud API for cloud commands: `https://api.<org>.phloem.ai` (default: your sign-in's, else this machine's pairing)
-f, --format <FORMAT>`table` for people, `json` for scripts [default: table]
-h, --helpPrint help
-V, --versionPrint version