@pidgeyjs/cli

CLI tools for managing Pidgey background jobs.

Installation

pnpm add -D @pidgeyjs/cli

Usage

pnpm pidgey <command>

Commands

pidgey jobs

Manage jobs in the queue.

# View queue status
pnpm pidgey jobs status

# List all jobs
pnpm pidgey jobs list

# List failed jobs
pnpm pidgey jobs list --status failed

# List jobs in a queue
pnpm pidgey jobs list --queue emails

pidgey jobs retry

Retry failed jobs.

pnpm pidgey jobs retry --id <job-id>
pnpm pidgey jobs retry --failed

pidgey jobs cancel

Cancel a pending or active job.

pnpm pidgey jobs cancel --id <job-id>

pidgey jobs delete

Delete jobs (single by ID or bulk by filter).

# Delete a specific job
pnpm pidgey jobs delete --id <job-id>

# Delete all failed jobs
pnpm pidgey jobs delete --status failed

# Delete jobs in a queue
pnpm pidgey jobs delete --queue emails

pidgey worker

Manage the background worker.

# Development mode
pnpm pidgey worker dev

# Production mode
pnpm pidgey worker start

pidgey schedules

Manage scheduled (cron) jobs.

# List scheduled jobs
pnpm pidgey schedules list

# Pause a scheduled job
pnpm pidgey schedules pause <schedule-name>

# Resume a paused scheduled job
pnpm pidgey schedules resume <schedule-name>

# Delete a scheduled job
pnpm pidgey schedules delete <schedule-name>

License

MIT