Documentation

Build background jobs with JobOrc

Plain-language guides for integrating the platform — not internal engineering specs.

CLI essentials

The jobs CLI talks to the same HTTP API as the SDK. Configure with env vars or a profile.

Environment

>_example.bash
BASH
export JOBORC_API_KEY=jk_...
export JOBORC_PROJECT_ID=01a0...
export JOBORC_BASE_URL=https://api.your-domain.com

Common commands

>_example.bash
BASH
# Enqueue a job (shape depends on your installed CLI version)
jobs jobs enqueue --type email.send --queue default --payload '{"to":"a@b.co"}'
# List recent jobs
jobs jobs list
# Inspect a job
jobs jobs get --id <job-id>

Prefer the SDK inside application code. Use the CLI for ops smoke checks and one-off enqueues.