For AI agents: the complete documentation index is available at /bull-board/llms.txt, the full documentation bundle is available at /bull-board/llms-full.txt, and this page is available as Markdown at /bull-board/guide/getting-started.md.

Installation

Install the core @bull-board/api plus one adapter for your framework.

Prerequisites

  • Node.js 20+ or Bun 1.x. CI covers Node 20, 22 and 24.
  • A running Redis instance
  • Bull or BullMQ already set up in your app
Sharing an ioredis connection?

bull-board reads your existing Bull/BullMQ queues, so it inherits their Redis connection. If you construct BullMQ with a shared ioredis instance rather than a plain { host, port }, BullMQ requires that connection to be created with maxRetriesPerRequest: null. This is a BullMQ requirement, not a bull-board one, but it's the most common setup snag. See the BullMQ connection docs.

Install

Pick the adapter that matches your framework:

FrameworkInstall command
Expressnpm install @bull-board/api @bull-board/express
Fastifynpm install @bull-board/api @bull-board/fastify
NestJSnpm install @bull-board/api @bull-board/nestjs
Koanpm install @bull-board/api @bull-board/koa
Hapinpm install @bull-board/api @bull-board/hapi
Hononpm install @bull-board/api @bull-board/hono
H3npm install @bull-board/api @bull-board/h3
Elysianpm install @bull-board/api @bull-board/elysia
Bunnpm install @bull-board/api @bull-board/bun

Next steps