Files
socktop/socktop
jason 20966d0c94 fix(socktop): explain how to install socktop_agent when demo mode can't find it (#36)
Demo mode spawns a socktop_agent child process, but the agent is a separate
crate that `cargo install socktop` does not pull in. When it was missing, the
raw spawn error propagated to main and printed as
`Error: Os { code: 2, kind: NotFound, message: "No such file or directory" }`,
which gives the user nothing to act on.

Introduce DemoAgentError so a NotFound spawn failure is distinguishable from
other io errors, and print the path we looked for plus the `cargo install
socktop_agent` fix. Other spawn errors still propagate as before.

Co-authored-by: Jason Witty <jason@localhost-live.localdomain>
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-18 21:10:46 -07:00
..

socktop (client)

Minimal TUI client for the socktop remote monitoring agent.

Features:

  • Connects to a socktop_agent over WebSocket / secure WebSocket
  • Displays CPU, memory, swap, disks, network, processes, (optional) GPU metrics
  • Selfsigned TLS cert pinning via --tls-ca
  • Profile management with saved intervals
  • Low CPU usage (request-driven updates)

Quick start:

cargo install socktop
socktop ws://HOST:3000/ws

With TLS (copy agent cert first):

socktop --tls-ca cert.pem wss://HOST:8443/ws

Demo mode (spawns a local agent automatically on first run prompt):

socktop --demo

Full documentation, screenshots, and advanced usage: https://github.com/jasonwitty/socktop