Frameworks

Koa

Mount Workbench in a Koa app with @getworkbench/koa middleware.

Install

Shell
npm i @getworkbench/koa bullmq koa

Mount

TypeScript
import Koa from "koa";
import { Queue } from "bullmq";
import { workbench } from "@getworkbench/koa";

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

app.use(workbench({ queues: [emailQueue], basePath: "/jobs" }));
app.listen(3000);

basePath required — Koa has no built-in mount helper, so pass basePath so the middleware matches its prefix and forwards everything else.

Resources

TanStack Start

Mount Workbench in TanStack Start with @getworkbench/tanstack-start server route handlers.

Astro

Mount Workbench in Astro server routes with @getworkbench/astro.

On this page

InstallMountResources