Output forms

Every read command renders through the same flags. This page shows each form once, on real commands; the rest of the guide sticks to the default table and names the other forms only when one is the point.

Flag	Values	Default	What it does
-o, --output	table | wide | name | json | yaml	table	the shape of the answer
--jq <expr>	a jq expression	—	pipe the JSON form through gojq; implies JSON
-w, --watch	bool	off	watch a listing: the snapshot, then only changes
--chunk-size <n>	int	500	list page size; the pages walk invisibly; 0 — one unpaginated request

-o table — the default

$ graphenectl get run -p Terminated
RUN          PIPELINE      STATUS      LABELS
watch-demo   perf-nightly  Terminated
val-c        perf-nightly  Terminated

-o wide — more columns

Records gain the pending-commands counter and the deletion mark:

$ graphenectl get pipeline -o wide
REF                    PHASE  OWNER  PENDING  DELETING  LABELS
pipeline/perf-nightly  ready         0        false

-o name — refs only, xargs-ready

$ graphenectl get run -o name
watch-demo
val-c
val-b

$ graphenectl get docker-volume -o name | xargs -I{} graphenectl delete {}

-o json

The protojson form, stable field names:

$ graphenectl get run watch-demo -o json
{
  "status": "Terminated"
}

-o yaml

The same fields through the YAML mapping:

$ graphenectl get run watch-demo -o yaml
status: Terminated

--jq — the scripting form

One expression over the JSON form; strings print raw (jq -r behavior). On streams the expression runs per message:

$ graphenectl get run --jq '.runs[].runId'
watch-demo
val-c
val-b

$ graphenectl pipeline show perf-nightly --jq .image
localhost:7233/default/perf-nightly:4f925b8c6e5fff45

$ graphenectl events run demo --jq 'select(.kind == "activity-failed")'

-w — watching a listing

The first frame prints in full, then only rows that appeared, changed, or went away (marked deleted):

$ graphenectl get run -w
RUN          PIPELINE      STATUS      LABELS
watch-demo   perf-nightly  Terminated
demo-2       perf-nightly  Running
demo-2       perf-nightly  Completed

-w composes with -o json and --jq: every change arrives as one message.

--chunk-size — pagination

Listings walk the server in pages of --chunk-size (default 500) — invisibly: the pages accumulate into one reply for every output form, -w included. --chunk-size 0 asks for everything in one request.

$ graphenectl get run --chunk-size 100 -o name | wc -l
1187