plottypus docs
Everything here describes plottypus 1.0.0, the version you can download today. Features planned for 1.1 are marked as coming, never as available.
Start#
- Install
- Install plottypus 1.0.0 on an Apple Silicon Mac with the install script or the tarball, and check its SHA-256 yourself.
- Quickstart
- Five minutes with plottypus: the two surfaces, the footer, the process table and the three keys worth learning first.
- Supported Macs
- Which Apple Silicon Macs plottypus 1.0.0 runs on, what each kind of Mac shows, and what has and has not been checked on real hardware.
Reading the screen#
- Surfaces: Work and Glance
- plottypus has two layouts. Work puts the machine beside the process table; Glance is one column of graphs for a small always-on window.
- Panels
- What every number in the cpu, gpu, mem, heat, power, net and disk panels means, where it comes from, and when it is absent instead of zero.
- Processes
- The process table: per-core CPU like Activity Monitor, footprint memory, why some rows show a dash, sorting, tree, filter, and signals that cannot hit the wrong pid.
Using it#
- Keys
- Every key in plottypus 1.0.0 for the default, htop and btop profiles, plus the mouse. Taken from the keymap source, the same table the in-app help reads.
- Settings and config file
- The settings page, where config.toml lives, every key with its default, and how plottypus saves without touching your comments.
- Themes and glass
- How plottypus builds its colours from your terminal's palette, the ten built-in themes, glass mode for translucent windows, extra contrast, NO_COLOR and tmux.
Scripting#
- JSON output
- plottypus --json and --json-stream, schema 1: every field, its unit, when it is null, and the names it shares with macmon.
- Diagnose and doctor
- plottypus --diagnose gives one verdict on the Mac with the evidence behind it; plottypus doctor prints what this Mac exposes, for bug reports.
Reference#
- Pro and the licence file
- What is free, what Pro will add, and how the offline Ed25519 licence file works. Pro is not on sale yet.
- Troubleshooting
- Broken graphs, wrong colours, tmux and ssh, Terminal.app, missing sensors, and processes that show a dash: what causes each and what to do.
- FAQ
- Short answers: sudo, network, cost, why a dash instead of zero, why CPU watts blink on macOS 27, and how plottypus differs from powermetrics and Activity Monitor.