Glossary
Words used in these docs.
New to Xyte or the command line? Start here. Every term below appears in the guides and reference pages, written in plain language for both non-technical operators and engineers.
Reading order: if you are brand new, skim Xyte concepts first, then open Set up and verify readiness.
Xyte concepts
The things in your Xyte account that commands read and change.
| Term | Plain meaning |
|---|---|
| Tenant | Your Xyte organization or partner account — the remote system the CLI reads and writes. You pass it as --tenant <tenant-id>. |
| Profile | A local, named connection to one tenant: its stored API key and settings. --tenant <tenant-id> selects a profile; the default profile is named default. |
| Alias | A short local nickname for a tenant profile, handy when one machine manages more than one Xyte connection. |
| Space | A place in your Xyte location tree — a site, building, floor, or room. Devices live in spaces, and a path such as Campus / Building A / Room 101 identifies one. "Move a device" means change its space. |
| Device | A piece of hardware Xyte manages, such as a display, room system, or sensor. |
| Fleet | All the devices in your tenant, taken together. A "fleet inspection" summarizes their state. |
| Incident | An open problem Xyte raised about a device or space — for example offline or faulty. "Triage" means understanding what is active and what changed. |
| Ticket | A support record attached to a device or incident, used to track and message about the issue. |
| Edge proxy | An Xyte Edge appliance on the local network that represents devices which are not directly cloud-connected. Those devices are "behind" the proxy and are reached through it by IP. |
| Claim | Registering a physical device into your tenant so Xyte can manage it. |
| Claim path | How a device is claimed. Native / direct: you have its serial, MAC, and cloud id. Edge: it sits behind an Edge proxy and is identified by IP plus a device model id. Cloud-to-Cloud (C2C): not available through the public API today — claim it from the Xyte End Customer Portal. |
| Provider scope | Whether a read targets organization data or partner data. Setup picks the key provider (xyte-org or xyte-partner); read commands pick the scope with --provider-scope organization|partner|auto. Most people leave scope on auto. |
Command & output terms
How the CLI runs work and what it gives back.
| Term | Plain meaning |
|---|---|
| Flow | A repeatable, multi-step workflow — such as remediation or a daily report — that you run with one command: xyte-cli flow run <flow-id>. |
| Plan / apply | --plan previews what a change would do without doing it. --apply performs it, only after you approve. |
| Dry run | A preview that writes nothing. The utility imports (util import-tree, util move-devices) are dry-run by default — add --apply to write. Edge claims preview with --plan. |
| Approval gate | A pause a write-capable flow makes before a change. It shows nextAction and waits for you to resume with --apply. |
| Run id / resume path | The id or bundle path that identifies one flow run, used to continue a paused or interrupted run: --apply --resume <run-id-or-path>. |
| Artifact | A file a command writes — usually JSON, NDJSON, Markdown, PDF, or a run bundle — saved with --out or --out-dir. |
| Schema / contract | The JSON shape a command promises, named like xyte.status.v1, so automation can read fields instead of scraping terminal text. |
| Strict JSON | Machine-readable output with no terminal decoration. Pair --output json with --strict-json when a job will parse the result. |
| NDJSON | "Newline-delimited JSON" — one JSON object per line. Used for watches and batch reports; validate one line at a time. |
| Workspace | The folder where the agent or terminal runs commands. |
Where to go next
I want to get set up
Open Set up and verify readiness or the Getting started reference.
I need to do a task
Browse the use-case guides and pick the one that matches your work.
Something is not working
See Troubleshooting for fixes and reset steps.