CLI Overview

The onepin CLI is bundled with pip install onepin. It provides a terminal interface for all OnePin operations — useful for scripting, CI pipelines, and interactive exploration.

Command tree

onepin --help
onepin --version
onepin login   [--key KEY] [--base-url URL]
onepin logout
onepin whoami
onepin workflows list
onepin workflows show  <WORKFLOW_ID>
onepin workflows run   <WORKFLOW_ID> [--watch]
onepin workflows runs  <WORKFLOW_ID> [--limit N]
onepin voices list [--limit N] [--locale LOCALE]
onepin templates list
onepin templates show  <TEMPLATE_ID>
onepin templates run   <TEMPLATE_ID> [--name NAME]
onepin uploads create  --file PATH --category {script|dictionary}
onepin uploads confirm <UPLOAD_ID> --workflow-id WORKFLOW_ID
onepin uploads delete  <UPLOAD_ID>

Global flags

Output format

Table (default): rich columns, truncated to terminal width, color-coded status values.

JSON (--json): machine-readable, unwrapped .data payload. Pipe to jq:

$
onepin workflows list --json | jq '.[].id'

Errors always go to stderr, even in --json mode. Successful data always goes to stdout.

Accessibility

• NO_COLOR=1 env var disables all ANSI output (honors the W3C spec)
• Non-TTY detection: when stdout is not a terminal, color and progress bars are automatically disabled
• ONEPIN_ASCII=1 or --no-unicode: replaces Unicode glyphs (✓ → [ok], ✗ → [err]) for Windows cmd.exe or SSH-piped environments

Authentication precedence

1. --api-key flag
2. ONEPIN_API_KEY environment variable
3. ~/.onepin/credentials file (written by onepin login)

See Authentication for the full credential resolution spec.

Exit codes