Skip to content

Dashboards

This content is for the 1.0.0 version. Switch to the latest version for up-to-date documentation.

A dashboard is a grid of metric cards. Each card reads one value from one source: a shell command that PocketCmd runs over SSH, or a catalog metric collected by a paired PocketCmd Server. Dashboards are listed in the Dashboards strip on the home screen and in the Dashboards area of the desktop sidebar.

Free includes one dashboard and all SSH command cards. More dashboards and catalog metrics from a paired server require PocketCmd Pro. On Free, catalog-metric cards stay on the dashboard but fetch nothing, and a banner explains why.

  • From the home screen: tap New dashboard at the end of the Dashboards strip and enter a name. The dashboard opens empty; tap + to add the first card.
  • From a server: open the server sheet and tap Add a metric. Pick an existing dashboard or start a new one. The card editor opens with that server already selected as the source.

The server sheet’s Dashboards section lists every dashboard with at least one card that reads from that server.

To rename or delete a dashboard, long-press it in the strip or the Dashboards list and choose Rename or Delete.

A dashboard is not tied to one server. Each card picks its own source in the editor under Pull this card from…:

Source How the value is read History
SSH host PocketCmd runs your shell command over an SSH connection to the server and parses the output. Samples are stored on this device.
Team server (catalog metric) PocketCmd reads a metric that a paired server collects by running an approved command. Read from the server’s own time-series store.

SSH command cards need nothing on the server except a shell. Catalog metrics need a paired PocketCmd Server and are the only cards that can carry alerts.

A paired server has no metrics of its own. Its catalog lists only the commands your team requested under Team › Metric requests and that were approved; until then the editor says “This server has no metrics yet.” Adding or removing a card never changes what the server collects. See Monitoring.

When several cards read from the same host, PocketCmd polls that host once per refresh for all of them.

Type Expected output Shows
Text Any text The output as plain text, optionally multiline and monospaced
Chart One number The value graphed over the dashboard’s time range
Bar One number A progress bar over a value range
Gauge One number A circular dial over a value range
Status A keyword A colored dot: green for active, running, up, ok, healthy, online or 1; orange for degraded, warning or reloading; red for anything else
Donut Two or more key=value lines with numeric values One slice per line

Bar and gauge cards default to a 0–100 range. Set Min and Max under Visualization to show values such as temperature or load average at full scale. Chart cards can hide their axis labels for a bare trend line.

Tap a card on the dashboard and choose Edit, or tap + to add one. The editor has four sections:

  • Data: the source, the label, the command (or the catalog metric), and an optional unit. Test runs the command and checks the output against the card type, for example “Expected a single numeric value.”
  • Visualization: the card type, the value range for bars and gauges, axis labels for charts.
  • Typography: auto-fit or a fixed font size, alignment and whether the header is shown.
  • Appearance: accent, value and background colors, background opacity, corner radius (0–24, default 10) and inset padding (0–16, default 8).

If the value cannot be verified when you save (the host is unreachable, or the output doesn’t match the type yet), the card is saved anyway and the editor tells you what it found. A sample of the card stays pinned above the settings so every change is visible while you scroll.

Every dashboard uses the same 16-column grid on every screen. Cells are square and fill the available width, so a layout arranged in a desktop window looks the same on a phone. New cards start at 4×2 cells.

Size and position are edited on the dashboard itself, not in the card editor.

  • Move: on a touchscreen, long-press a card and drag it. With a mouse or trackpad, drag it directly. Other cards move out of the way.
  • Resize with a preset: tap the card and pick a size: Tile (4×2), Square (4×4), Wide (8×2), Half (8×4), Banner (16×3) or Full (16×6).
  • Resize freely: tap the card and choose Edit size. Drag the handles on the card’s edges and corners, or use the width and height steppers in the banner, then save.

The dashboard list and the home strip show dashboards read-only. Tap one to open it for editing.

The dashboard’s toolbar holds two controls that apply to every card on it:

Control Options Default
Time range Min, Hour, Day, Week, Month, Year (tap to cycle) Hour
Refresh interval 1, 5, 15, 30 or 60 seconds (tap to cycle), or any number of seconds (long-press) 15 seconds

Refresh now fetches every card immediately. If no fresh data arrives, a banner shows how old the values are. If a host never answers on the first load, the dashboard shows Host unreachable with a retry button instead of empty cards.

Samples from SSH command cards are stored in a separate database on the device. Set how long they are kept in Settings › Data › Metric history retention: 7 days (default), 14, 30 or 90 days. A cleanup runs once a day.

History for catalog metrics comes from the paired server and follows the server’s retention setting. See Monitoring.

The home screen never opens an SSH connection. In the Dashboards strip, SSH command cards show the last value stored on the device, and only catalog metrics from paired servers are polled.

The home screen’s tag chips filter dashboards too. A dashboard matches a tag when any server its cards read from carries that tag.