Output & scripting

The CLI is built to be scripted.

JSON output

Most read commands accept --json for machine-readable output:

verentis workspace list --json | jq '.[].id'
verentis exec get <executionId> --json

Paged listings also accept --page, --page-size and --order-by.

Errors

Errors render as compact RFC 7807 problem details, and the process exits with a non-zero exit code so pipelines fail fast:

if ! verentis exec run /scripts/etl.py --follow; then
  echo "execution failed"
  exit 1
fi

The raw API in scripts

For endpoints without a dedicated command, verentis api returns the raw response and reads request bodies from files or stdin:

echo '{"name":"thing"}' | verentis api POST /v1/things --body - --scope some.scope --workspace <id>
verentis api GET /v1/roles --scope security.role.read-all --raw | jq