roark calls the Roark Analytics API from the command line. Commands read noun before verb, so the resource is what you type first and the verb is one of list, get, create, update or delete unless the operation is genuinely something else.
Global options
Every command accepts these in addition to its own options.url
API base URL.
token
Bearer token. Prefer
ROARK_API_BEARER_TOKEN or the stored credential.ms
Request timeout in milliseconds.
count
Retries for retryable failures.
format
Output format: auto, json, jsonl, plain.
switch
Shorthand for
--format json.switch
Disable colour.
switch
Suppress non-essential output.
switch
Send the stored credential to a base URL set by a project
.roark.json. Refused by default.Sending a body
Commands that send a request body accept these as well.json
Request body as JSON, or @file to read one (@- for stdin).
switch
Skip confirmation prompts.
switch
Never prompt; fail instead.
Configuration
Settings are resolved highest precedence first: command line flag, environment variable, project.roark.json found by walking up from the working directory, then the user config file. The stored credential is written with mode 0600.
Environment
Exit codes
Distinct per failure mode, so a CI job can tell a rejected request from a missing credential without reading stderr.Commands
roark <command> --help prints the same options any of these pages lists.