Reading resources

The PineXQ CLI can read every resource in your context. Each resource type is a noun with two verbs — list (many) and show <ref> (one):

Command	Alias	Resource
`pinexq job`		Jobs
`pinexq workdata`	`wd`	WorkData
`pinexq processing-step`	`ps`	ProcessingSteps
`pinexq template`		Action templates
`pinexq trigger`		Cron triggers
`pinexq folder`		Folders

These commands are read-only and run from any directory — unlike deploy, register, and generate, they do not need a project. To change resources, see Acting on resources; for a Job’s logs and metrics, see Job logs and metrics.

Connecting

Every read command resolves its endpoint and API key in this order:

the --endpoint / --api-key flags,
the PINEXQ_ENDPOINT / PINEXQ_API_KEY environment variables,
for the endpoint only, pinexq_endpoint in a pinexq.toml in the working directory.

export PINEXQ_ENDPOINT="jobs.api.dev.pinexq.net"
export PINEXQ_API_KEY="…"
pinexq job list

Output formats

-o, --output selects the format:

table (default) — a human-readable table.
json — a flat array of objects, one per resource, with id and url on every row and nested objects preserved.
csv — RFC 4180 with a header row.

Two more output flags:

--wide adds the extra columns to the table.
-q, --quiet prints only ids, one per line — handy for piping.

# every completed job's id, piped into another command
pinexq job list --state completed -q | xargs -n1 pinexq job show

JSON and CSV always carry the full column set and go to plain stdout, so they can be redirected safely.

Pagination and sorting

--limit sets the page size (max 1000) and --offset the start; --all fetches every page and overrides both.
--sort FIELD picks the sort field (the choices differ per resource) and --desc / --asc the direction. Each resource has a natural default — Jobs, WorkData, action templates, and triggers newest-first; ProcessingSteps by title and Folders by path, ascending.

pinexq job list --sort created_at --limit 20
pinexq job list --all -o json > jobs.json

Filtering

Filter flags are grouped under a Filters panel in each command’s --help. The families a resource exposes follow its JMA query:

Tags — --tag (repeatable, ANDed), --tag-or (repeatable, ORed), and --tql for a Tag Query Language expression.
Folder scope — --folder <path> and --recursive, where the resource supports it.
Dates — --created-after / --created-before (an ISO 8601 datetime or a bare YYYY-MM-DD).
Resource-specific flags — for example --state for Jobs, --kind and --media-type for WorkData, --function / --version / --deployment-state for ProcessingSteps, --enabled / --disabled for triggers, and --path-prefix for Folders.

Run pinexq <noun> list --help for the full set a noun supports.

pinexq wd list --kind clientupload --media-type text/csv --tag archived
pinexq ps list --deployment-state platform --function resize

Inspecting one resource

show accepts a resource’s UUID or its full URL for every noun. Two nouns accept a friendlier reference as well:

pinexq ps show <name> or pinexq ps show <name>@<version> resolves a ProcessingStep by function name — the latest version, or the pinned one.
pinexq folder show </path> resolves a folder by its path, and lists the folder’s direct child folders.

pinexq ps show resize
pinexq ps show resize@1.2.0
pinexq folder show /projects/foo
pinexq job show 3f2b… -o json

One example per resource

pinexq job list --state completed --sort created_at --limit 20
pinexq wd list --kind clientupload --media-type text/csv -o json
pinexq ps show resize@1.2.0
pinexq template list --tag nightly --wide
pinexq trigger list --enabled
pinexq folder show /projects/foo