Frameworks

AdonisJS

Mount Workbench in AdonisJS 6 or 7 with @getworkbench/adonis.

Install

Shell
npm i @getworkbench/adonis bullmq @adonisjs/core

Mount

TypeScript
// start/routes.ts
import router from "@adonisjs/core/services/router";
import { Queue } from "bullmq";
import { mountWorkbench } from "@getworkbench/adonis";

const emailQueue = new Queue("email", {
  connection: { url: process.env.REDIS_URL! },
});

mountWorkbench(router, "/jobs", { queues: [emailQueue] });

basePath — the mount path /jobs is passed to mountWorkbench and used internally.

Works with AdonisJS 6 and 7.

Resources

NestJS

Mount Workbench in a NestJS app with @getworkbench/nestjs on Express or Fastify platform.

Next.js

Mount Workbench in a Next.js App Router app with @getworkbench/next catch-all route handlers.

On this page

InstallMountResources