Skip to content
YomiroYomiro Docs

Command line (yomiro CLI)

yomiro is a single binary that talks to the same API the web app uses. Anything you can do by clicking, you can script — and the gateway daemon that bridges your on-prem systems is part of the same tool.

Installing

Section titled “Installing”
Terminal window
curl -fsSL https://yomiro.io/install.sh | sh

Signing in

Section titled “Signing in”
Terminal window
yomiro auth login

Two flows, and the right one depends on where you are:

Flow When
yomiro auth login Non-interactive. Mints a key immediately with read-only defaults, or whatever you pass to --scopes. This is the CI flow.
yomiro auth login --web Opens the web app so you pick scopes and key lifetime yourself. This is the flow for your own laptop.

Both use the Auth0 device-code flow and mint a long-lived API key with scoped permissions. Check what you have with:

Terminal window
yomiro auth whoami

Keys can also be issued from the web app — see API keys. Manage them from the CLI with yomiro auth token create | list | revoke.

Environments

Section titled “Environments”

One binary, several tenants. --env selects a profile:

Terminal window
yomiro --env dev device list
yomiro --env prod incident list

Valid values are local, dev, staging and prod. YOMIRO_ENV sets it for a whole shell.

Resolution order for where a request goes and what it authenticates with, highest first:

  1. --api-url / --token flags
  2. YOMIRO_API_URL / YOMIRO_API_TOKEN
  3. The active --env profile
  4. Whatever yomiro auth login stored

That ordering is what lets the same binary be pointed at a different tenant from CI without re-authenticating.

Command groups

Section titled “Command groups”

Each group maps to something in the web app.

Operations

Section titled “Operations”
Group For
capture Captured frames and events — the core artifact
incident Review and resolve incidents
alert Create, enable and acknowledge alert rules
dashboard Read and author dashboards
analytics Read-only summaries, trends and Grafana links, for scripted reporting

Devices and inspection

Section titled “Devices and inspection”
Group For
device Register and manage edge devices
device-group The groups configuration attaches to
ai-config Detection settings per device group — what triggers a capture
jetson-nano A device’s camera streams, and which one runs inference
inspection-profile Golden-image and inspection profiles
model List, upload and download inspection models
ref-sheet Versioned reference sheets
otel-endpoint OTLP ingestion endpoints for your own observability stack

Organization

Section titled “Organization”
Group For
location The site → area → line → unit hierarchy
user User records
team Teams and membership
organization Org settings — logo, MQTT config
ai-provider Providers, bring-your-own-key, model discovery
data-source Data sources, including gateway-proxied ones
agent Agent configs, hooks and heartbeat tasks
entity-history Recent-entity history and soft-delete restore

yomiro <group> --help lists what each one supports.

The gateway daemon

Section titled “The gateway daemon”

yomiro gw runs the connector that exposes on-prem databases to the platform over an outbound-only tunnel.

Command Does
gw init Configure with a token and a database URL
gw up Connect and stay connected
gw status Show the connection state
gw logs Read daemon logs
gw reload Re-read configuration without dropping the tunnel
gw pause / gw resume Suspend and restore query serving
gw down Disconnect

Setup is covered in Gateway & integrations, which generates the exact init command with a token already embedded.

Scripting it

Section titled “Scripting it”
Terminal window
export YOMIRO_API_TOKEN="yom_pat_..."
export YOMIRO_ENV=prod


yomiro device list
yomiro incident list

Use a separate key per pipeline so revoking one does not break the others.

Section titled “Related”