CLI
The standalone flexiq command.
The standalone flexiq command.
flexiq [--db <path> | --backend <b> --dsn <dsn>] <command> [args] [--json]Connect with --db (SQLite) or --backend/--dsn (Postgres/Redis). --json
on read commands prints machine-readable output.
| Command | Description |
|---|---|
enqueue <task> '<jsonArgs>' | Enqueue a job. |
stats [-q <queue>] | Overall stats, or a single queue's with -q. |
jobs [--status <s>] [--limit <n>] | List jobs. |
cancel <jobId> | Cancel a pending job, or request cancellation of a running one. |
pause <queue> / resume <queue> | Queue control. |
paused | List paused queues. |
dlq list / dlq retry <id> / dlq delete <id> / dlq purge [--older-than-ms <n>] | Dead-letter (DLQ) ops. |
run <module> [--queues a,b] | Load a module exporting a Queue and run its worker. |
dashboard [--port <n>] | Serve the dashboard. |
scaler [--port <n>] [--target-queue-depth <n>] | Serve the KEDA scaler metric endpoint. |
autoscale <module> [--min-workers <n>] [--max-workers <n>] | Scale worker processes to queue depth — see Autoscaling. |
flexiq --db flexiq.db enqueue add '[2,3]'
flexiq --db flexiq.db jobs --status failed --json
flexiq run ./app.js --queues default,emailsThe CLI ships in the package bin; see the CLI guide
for the worker and dashboard entrypoints.