Skip to content
BarkVisor BarkVisor

Product terminology

Shared words for BarkVisor in the UI and getting-started docs. The domain glossary is CONTEXT.md. This file is the UI and API mapping. Do not invent a third glossary.

A single-device install is a Home of one. More Devices join that Home later; they are not a cluster.

Shared table

Section titled “Shared table”
TermUser-facing meaningCode / API (keep as-is)
HomeA person’s set of Devices (one or more)/api/home/devices registry + /api/home/devices/health + member proxy
DeviceThe Mac, PC, or board running this BarkVisor daemonInventory JSON keeps hostId, hostname, and host metrics
AgentThe daemon role on a Device/api/agent/*, barkvisor or barkvisor-agent
WorkloadA Virtual Machine or an App on a DeviceVM, WorkloadSpec
LibraryImages and templates you can deployImage / template repositories
NodeDo not use in product copy—
ClusterDo not use in product copy—
DatacenterDo not use in product copy—
QuorumDo not use in product copy—

host is still correct in code, inventory JSON, and OS-level phrasing (host port, host path, host CPU model, Linux host bridge). Map those facts to Device whenever the reader is a person using the SPA.

USB device still means a peripheral. A BarkVisor Device is the computer.

SPA rules

Section titled “SPA rules”
  • No “node”, “cluster”, “datacenter”, or “quorum” in user-visible strings (frontend/src/**/*.vue templates).
  • Say Device (or “this device”) when you mean the machine running the daemon. Do not use This Device as a stand-in name; show the Device’s display name.
  • Say Home when you mean the person’s set of Devices. One Device is already a Home.
  • Networks live at Networks (/networks), not Settings → Network.
  • First-run setup is SetupView (/setup). Do not add a second overlay wizard.
  • Join an existing Home with barkvisor join --code, or barkvisor-agent join --code on an API-only Device. The CLI posts to the console-local /api/pairing/join endpoint. The web setup wizard creates a new Home. Pairing offers and phone sign-in QRs live under Settings → Pairing. Settings → Home sets the Device URL. Settings → Library sets the image folder; Settings → Repositories manages catalogs.
  • The sidebar Device picker is All (Home union) or one Device. List pages filter to that scope. Create VM still has its own placement picker.
Section titled “Related”