CLI overview

Use the purrkey executable to discover tools, make account-balance calls and recover results.

On this page

Commands
JSON output
Choose a reference

Commands

Command	Purpose
purrkey version	Print the installed version.
purrkey keys add	Verify and save an API key.
purrkey config	Configure credentials using hidden input or stdin.
purrkey tools	Read the accessible tool directory.
purrkey discover	Find candidate tools by capability.
purrkey inspect	Read a tool's schema, price and limitations.
purrkey balance	Read available funds and reservations.
purrkey run	Submit or recover a saved request.
purrkey get-run	Retrieve an original Run.
purrkey cancel-run	Request cancellation of an original Run.

Tool commands print JSON and preserve exact integer values. Use --output <file> to save the full response locally. On macOS and Linux the file uses owner-only permissions; on Windows, access depends on the directory permissions because the CLI does not configure a private Windows ACL. Read result.status and billing before interpreting output.

Shell

purrkey balance --output balance.json
purrkey tools --output tools.json

Choose a reference

ConfigurationAPI keys, environment variables and origin selection.Discover and inspectTool selection commands and flags.Run a toolRequest files, waits and output.Retrieve and cancelWork with the original Run ID.

Commands

JSON output

Choose a reference