Skip to content

Device commands

Device commands let an operator check an Edge from the chat in the Privitty App: list commands, fetch logs, see status and read CPU usage.

Before you begin

  • The operator has an active grant on the Edge with Device commands selected. See Grant access to an Edge.
  • The Edge is online and shows In sync.
  • The chat with the Edge has appeared in the App.

Commands

The Edge accepts these four commands.

Command What it does Argument Reply
/help Lists all available commands None Text
/logs Fetches recent system log lines n: 50, 100, 500 or 1000. Default 50. A log file
/status Edge health and uptime None Text
/cpu-utilization CPU usage per core None Text, or a file if long

/logs returns a file named privitty-logs-{n}.log, which the App opens in its secure viewer. On a host with no system log, such as a container, the file starts with a header saying it shows only the Edge agent's own log lines.

Example /status reply:

privitty-edged v1.0.0
OS:      linux (x86_64)
Uptime:  05h 12m 40s
Status:  running

On Linux, /cpu-utilization lists cumulative time counters for each core, not percentages. On Windows it reports total processor time as a percentage.

Send a command

  1. Open the chat with the Edge. The message box shows Type '/' for commands.
  2. Type /. Keep typing to filter the list.
  3. Use the arrow keys and press Enter, or click a command.
  4. For /logs, choose a value for n. Commands without an argument are sent at once.

Press Esc or select Cancel to close the list.

  1. Open the chat with the Edge. The message box shows Type / for commands.
  2. Type /. Keep typing to filter the list.
  3. Tap a command.
  4. For /logs, tap a value for n.
  1. Open the chat with the Edge.
  2. Type /. A Commands sheet opens.
  3. Tap a command.
  4. For /logs, type 50, 100, 500 or 1000 and tap Send. Other values are refused.

While the Edge works on a command, desktop and Android show "Waiting for device…". The reply then appears in the chat. Wait for replies before you send many commands in a row.

If a command does not work

What you see What to do
"Device commands not enabled" (desktop) or "Device commands are not enabled for this session" (Android) Check that the grant shows · commands and is active, and that the Edge shows In sync.
device commands are not entitled The Edge's licence does not allow device commands, or has ended. See Billing and usage.
"Command no longer available — capabilities updated" Type / again and pick from the updated list.
"Waiting for device…" does not clear Bring the Edge online.
No command list when you type / Check the grant. Wait a moment after the chat first appears.

Next steps