@joborc/cli
v0.2.1
Published
Official JobOrc CLI — enqueue jobs, manage queues, and run workers with only an API key
Maintainers
Readme
@joborc/cli
Official command-line client for JobOrc.
Binaries: jobs and joborc.
Install
npm install -g @joborc/cli
# or
pnpm add -g @joborc/cliRequires Node.js 20+.
Quick start (API key only)
- Create an API key in the JobOrc dashboard (Project → Settings → API keys).
- Authenticate:
export JOBORC_API_KEY='jk_live_...'
# or save it:
jobs login --api-key 'jk_live_...'- Enqueue and inspect jobs — no project id or base URL required on hosted JobOrc:
jobs whoami
jobs jobs enqueue email.send --payload '{"to":"[email protected]"}' --queue default
jobs jobs list --status queued
jobs jobs get <jobId>
jobs queues list
jobs workers listLocal / self-host only:
export JOBORC_BASE_URL=http://localhost:8080Common commands
| Command | Purpose |
|---------|---------|
| jobs login --api-key … | Save credentials to your profile |
| jobs whoami | Show active identity / project from the key |
| jobs jobs enqueue … | Enqueue a job (PC-01) |
| jobs jobs list \| get \| cancel \| replay | Inspect / control jobs |
| jobs queues … | Manage queues |
| jobs logs <jobId> | Fetch job logs |
| jobs schedule … | Cron schedules (if enabled) |
| jobs init | Scaffold local .joborc config from your API key |
| jobs --help | Full help |
Configuration
| Variable / flag | Required? | Purpose |
|-----------------|-----------|---------|
| JOBORC_API_KEY / --api-key | Yes | Project API key |
| JOBORC_BASE_URL / --base-url | No | Defaults to hosted API |
| JOBORC_PROJECT_ID / --project | No | Optional override |
Security
- Prefer env vars over argv for secrets (argv is visible in process lists).
- Never commit live keys.
- Keys are show-once at creation — store in a vault.
Related
- SDK:
@joborc/sdk - Docs: quickstart in the JobOrc dashboard
