CLI Reference

Using the CLI

Everything you can do in the Pinman 2 interface, you can also do from the command line — and the CLI exposes additional power-user operations the UI does not. The two share the same underlying logic and the same vocabulary.

Invoking

The CLI ships with Pinman 2. Open a terminal and run pinman followed by a command:

pinman capture savepoint       # take a savepoint
pinman profile apply "My GPU"  # apply a profile
pinman machine status          # show machine status

Discovering commands

Add --help to any command or group to see its usage, options, and subcommands:

pinman --help                  # top-level command groups
pinman capture --help          # subcommands of the capture group
pinman capture savepoint --help  # options for one command

Add --verbose for detailed progress, or --debug for per-item diagnostics.

UI ↔ CLI parity

Command names match what you see in the interface. If an action is labelled “Savepoint” in the UI, the CLI equivalent is pinman capture savepoint. Nouns are singular (pinman device, pinman box).

Full command reference

Every command and group, with its complete --help output, is published as a single searchable reference generated directly from the CLI.

Open the full command reference →