Documentation

CLI

CLI

Binary name jobs (alias joborc). Thin client over the same /v1 API as the SDK.

Environment

example.bash
BASH
export JOBORC_API_KEY=jk_...
# Optional for local/self-host:
# export JOBORC_BASE_URL=http://localhost:8080
export CI=true # non-interactive

Global flags

  • --json — machine stdout
  • --project / --org — context
  • --yes — skip confirm
  • --base-url / --api-key — override env

Common commands

example.bash
BASH
jobs login --api-key "$JOBORC_API_KEY"
jobs whoami
jobs jobs enqueue email.send --payload '{"to":"a@b.com"}' --queue emails \
--idempotency-key welcome:1
jobs jobs list --status queued --json
jobs jobs get <jobId>
jobs jobs cancel <jobId> --yes
jobs jobs replay <jobId> --yes
jobs queues list
jobs queues create emails
jobs keys list
jobs workers list
jobs schedules list

Exit codes (selected)

  • 0 success · 3 auth · 4 not found · 6 rate limit
  • 15 feature deferred / unavailable (e.g. schedules FF off)

Prefer the SDK inside application code. Use the CLI for ops and CI smoke checks.