CLI Reference
Command-line tools for managing jobs and workers.
pidgey jobs
Manage jobs in the queue.
pidgey jobs list
List jobs with optional filters.
# List all jobs
npx pidgey jobs list
# List failed jobs
npx pidgey jobs list --status failed
# List jobs in a specific queue
npx pidgey jobs list --queue emails --limit 20Options:
--status— Filter by status (pending, active, completed, failed, cancelled)--queue— Filter by queue name--limit— Limit number of jobs (default: 10)--offset— Offset for pagination (default: 0)
pidgey jobs status
View real-time queue statistics.
npx pidgey jobs status
npx pidgey jobs status --poll-interval 500Options:
--poll-interval— Update frequency in milliseconds (default: 1000)
Output:
┌─────────┬─────────┬──────────┬───────────┬────────┐
│ Queue │ Pending │ Active │ Completed │ Failed │
├─────────┼─────────┼──────────┼───────────┼────────┤
│ emails │ 42 │ 5 │ 1,234 │ 3 │
│ reports │ 8 │ 2 │ 456 │ 0 │
└─────────┴─────────┴──────────┴───────────┴────────┘pidgey jobs retry
Retry failed jobs.
# Retry a specific job
npx pidgey jobs retry --id job_123
# Retry all failed jobs
npx pidgey jobs retry --failed
# Retry failed jobs in a specific queue
npx pidgey jobs retry --failed --queue emailsOptions:
--id— Retry specific job by ID--failed— Retry all failed jobs--queue— Filter by queue name (use with--failed)
pidgey jobs cancel
Cancel a pending or running job.
npx pidgey jobs cancel --id job_123Options:
--id— Job ID to cancel (required)
The Redis adapter does not support canceling jobs. Use deleteJob instead.
pidgey jobs delete
Delete jobs (single by ID or bulk by filter).
# Delete a specific job
npx pidgey jobs delete --id job_123
# Delete all failed jobs
npx pidgey jobs delete --status failed
# Delete all jobs in a queue
npx pidgey jobs delete --queue emails
# Delete failed jobs in a specific queue
npx pidgey jobs delete --status failed --queue emailsOptions:
--id— Delete a specific job by ID--status— Delete jobs by status (pending, active, completed, failed, cancelled)--queue— Delete jobs by queue name
pidgey worker
Manage the background worker.
pidgey worker dev
Start worker in development mode with verbose logging and fast polling.
npx pidgey worker dev
npx pidgey worker dev --concurrency 20pidgey worker start
Start worker in production mode with optimized settings.
npx pidgey worker start
npx pidgey worker start --concurrency 50Common Options:
--concurrency— Number of concurrent jobs (default: 10)--poll-interval— Polling interval in ms (dev: 100, prod: 1000)--jobs-dir— Jobs directory (default: jobs)
pidgey migrate
Run database migrations. This is optional—the worker runs migrations automatically on startup.
npx pidgey migrateUse this in CI/CD pipelines to run migrations before deploying your app, or to set up the database independently of the worker.
pidgey schedules
Manage scheduled (cron) jobs.
pidgey schedules list
List all scheduled jobs.
npx pidgey schedules listOutput:
┌────────────────┬──────────┬─────────────┬────────┬───────────────────────┬───────────────────────┐
│ name │ queue │ cron │ paused │ lastRun │ nextRun │
├────────────────┼──────────┼─────────────┼────────┼───────────────────────┼───────────────────────┤
│ daily-digest │ emails │ 0 9 * * * │ false │ 12/10/2024, 9:00:00 │ 12/11/2024, 9:00:00 │
│ cleanup │ default │ 0 0 * * 0 │ false │ 12/8/2024, 12:00:00 │ 12/15/2024, 12:00:00 │
└────────────────┴──────────┴─────────────┴────────┴───────────────────────┴───────────────────────┘pidgey schedules pause
Pause a scheduled job.
npx pidgey schedules pause daily-digestThe Redis adapter does not currently support pausing scheduled jobs.
pidgey schedules resume
Resume a paused scheduled job.
npx pidgey schedules resume daily-digestpidgey schedules delete
Delete a scheduled job.
npx pidgey schedules delete daily-digestNext Steps
- Worker — Run and scale workers
- API Reference — Programmatic job management
- Deployment — Production setup