Guides
Redis auto-discovery
Pass a Redis connection instead of explicit Queue instances — Workbench discovers queues from BullMQ keys.
Instead of passing explicit Queue[] instances, pass a Redis connection and let Workbench scan for BullMQ queues:
TypeScript
workbench({
redis: process.env.REDIS_URL!,
prefix: "bull", // optional, default "bull"
maxQueues: 100, // optional cap for large deployments
});Or via the core API:
TypeScript
import { WorkbenchCore } from "@getworkbench/core";
const core = await WorkbenchCore.fromOptions({
redis: process.env.REDIS_URL!,
prefix: "bull",
maxQueues: 100,
});When to use it
- Ops dashboards where you want every queue in Redis visible without redeploying when a new queue appears
- Standalone Docker deployments with
QUEUE_NAMESfor explicit lists (alternative approach) - Large fleets — set
maxQueuesto cap discovery cost
When to pass explicit queues
- You only want specific queues visible (security / noise reduction)
- Queue names aren't discoverable via standard BullMQ key patterns
- You need custom
Queueoptions per instance
Prefix
If your BullMQ deployment uses a non-default prefix, pass it explicitly:
TypeScript
workbench({ redis: process.env.REDIS_URL!, prefix: "myapp" });