visionctl reference
visionctl is the operator CLI for a running Vision Player box. It talks to
the local vision-core daemon over a UI control socket — no network access
is required for local operation.
visionctl status
visionctl playback pause --output HDMI-1
visionctl cache list --limit 50
Run visionctl --help or visionctl <subcommand> --help on the box for the
full flag reference; this page covers the parts that don't fit a --help
screen.
Examples
Print daemon and output state:
visionctl status
Pause playback on a specific output:
visionctl --output HDMI-1 playback pause
Seek 12 seconds into the current item:
visionctl playback seek 12000ms --output HDMI-1
Inspect and prune the content cache:
visionctl cache list --limit 50
visionctl cache purge --url https://example.com/image.jpg
visionctl cache prefetch https://example.com/clip.mp4 --content-type video
Stream performance samples every five seconds:
visionctl performance watch --interval 5s
Subscribe to cache events as JSON:
visionctl events watch --topic cache --json
Edit configuration:
visionctl config show --json
visionctl config set geometry 0,0,1920,1080 --output HDMI-1
Diagnostics bundles
visionctl diagnostics bundle asks the local vision-core daemon to create
a redacted support archive. Use --out to copy the completed archive to a
technician-selected path. Bundle collection works offline and does not
upload data.
Environment
| Variable | Purpose |
|---|---|
VISIONCTL_LOG | Log-verbosity filter for stderr output. Overrides the level implied by -v/-vv. Example: VISIONCTL_LOG=debug. |
XDG_RUNTIME_DIR | On Linux, the directory containing vision-ui.sock. Falls back to /run/user/$UID when unset. |
TMPDIR | On macOS, the directory containing vision-ui-<uid>.sock. Falls back to /tmp when unset. |
Files
| Path | Purpose |
|---|---|
${XDG_RUNTIME_DIR:-/run/user/$UID}/vision-ui.sock | UI control socket on Linux. |
${TMPDIR:-/tmp}/vision-ui-<uid>.sock | UI control socket on macOS. |
\\.\pipe\vision-ui-<sid> | UI control named pipe on Windows. |
Exit status
| Code | Meaning |
|---|---|
0 | Success. |
1 | Daemon operation error — the request reached the daemon but failed. |
2 | CLI usage error — invalid arguments or flags. |
3 | Cannot connect to vision-core — the daemon is not running or the socket path is wrong. Stderr includes the resolved socket path. |
4 | Request timed out. Adjust with --timeout. |
5 | Local file I/O error — e.g. failed to read a config file passed to config apply. |
See also
vision-config(1), systemctl(1), journalctl(1).
On a deployed Vision box, the full man page is available via man visionctl.