Skip to content
HamstikHamstik Docs

CLI commands and output

The CLI command reference will map commands to the Public API resources they use. Each command should document its required scope, resource identifiers, filters, pagination behavior, and failure modes.

Output formats

Automation-friendly output is expected to include JSON output for scripts and agents. Human-readable output can prioritize a compact view, but scripts should not parse table formatting when JSON is available.

Command reference shape

Each published command will include:

  1. the command synopsis;
  2. required authentication and scopes;
  3. examples with safe placeholder values;
  4. output examples for normal and JSON modes; and
  5. stable error handling guidance.

Until those commands are verified in the CLI repository, use the API resource guide as the authoritative behavior reference.