Global options and scripting

Global options

Global options can appear before or after the command.

Option	Behavior
`--profile NAME`	Select a configured profile; also available as `PARKES_PROFILE`.
`--org UUID`	Select an already authorized organization; also available as `PARKES_ORG`.
`--output table\|json\|jsonl`	Choose human-readable, JSON, or newline-delimited JSON output.
`--no-input`	Disable interactive confirmation. This does not approve mutations.
`--yes`	Approve mutations without prompting.
`--quiet`	Suppress normal command output.
`--verbose`	Enable diagnostic logging to stderr.
`--timeout DURATION`	Set the request timeout; default `30s`.
`--color auto\|always\|never`	Choose the color setting.
`--help`	Show help for the selected command.
`--version`	Show the installed version.

Output formats

Terminal output defaults to table; redirected stdout defaults to JSON. Use an explicit format when another program consumes the result:

parkes skills list --output json
parkes skills list --all --output jsonl > skills.jsonl

JSON preserves the response envelope. JSONL writes each resource as a separate line. --all fetches a page at a time; it does not load the full collection into memory. Always check the exit code. A stream interrupted by a failure can leave partial output; a file being present does not mean an export completed.

Paginated collections

List commands generally accept --limit, --cursor, and --all. The default page size is 50 and the maximum is 200. Search has its own bounded limits and is not an exhaustive export.

parkes knowledge list --namespace NAMESPACE_UUID --all --output jsonl

Use exact resource IDs returned by the API. Replace uppercase placeholders before running examples.

Confirm mutations

For an approved operation in an unattended script, pass both flags:

parkes skills create --file skill.json --yes --no-input

--no-input alone fails rather than silently accepting a write. Prefer file-based create/update commands over interactive edit in automation. Named writes generate an idempotency key for each invocation. A fresh invocation generates a new key, so blindly rerunning a timed-out command can repeat the operation. Inspect the resulting resource or use raw API requests with an explicitly preserved key when you need retry control.

Observe long-running work

parkes runs logs RUN_UUID --follow --output jsonl
parkes runs wait RUN_UUID
parkes activity tail --cursor-file .parkes-activity-cursor --output jsonl

Ctrl-C stops local observation; remote work can still be running. Log following may emit a message again when its content changes. Activity checkpoints support resumption, but consumers must deduplicate delivery_id; cursors expire after one day.

Exit codes

Code	Meaning
`0`	Success. A downstream closed pipe is also treated as a normal exit.
`1`	General, server, or local operation failure.
`2`	Invalid arguments, input, or missing noninteractive confirmation.
`3`	Authentication failure.
`4`	Permission denied.
`5`	Resource or requested schema not found.
`6`	Conflict or failed/missing version precondition.
`7`	Rate limit reached. Honor the reported retry delay.
`8`	Transport or response failure.
`130`	Interrupted. Remote work may still be running.

Environment variables

Variable	Purpose
`PARKES_PROFILE`	Select a configured profile.
`PARKES_ORG`	Select an already authorized organization.
`PARKES_TOKEN`	Supply a bearer credential instead of using the OS credential store.
`PARKES_CONFIG_DIR`	Override the directory for nonsecret CLI configuration.

Keep credentials out of arguments, profile files, source control, and logs.

Get started

Use the CLI

Command reference

Global options

Output formats

Paginated collections

Confirm mutations

Observe long-running work

Exit codes

Environment variables

​Global options

​Output formats

​Paginated collections

​Confirm mutations

​Observe long-running work

​Exit codes

​Environment variables

Global options

Output formats

Paginated collections

Confirm mutations

Observe long-running work

Exit codes

Environment variables