Skip to content
Get started
Get started
Install bunqueue, Setup Guide for Bun Job Queue
guide · installation

Install bunqueue, zero infrastructure.

One command installs everything: the library, the server, and the CLI. No Redis, no broker, nothing else to provision.

  • Bun v1.3.9 or later
Terminal window
bun add bunqueue

That is it. The package is 5.5 MB with 7 packages total, and includes the client library, the standalone server, and the CLI.

The Bun bunqueue package bundles the client, the server, and the CLI. Every other SDK is a client only: it connects to a bunqueue server, started once with bunx bunqueue start (see SDKs and Server Mode).

Save this as test.ts and run bun run test.ts:

import { Queue, Worker } from 'bunqueue/client';
// Both Queue and Worker must have embedded: true
const queue = new Queue('test', { embedded: true });
const worker = new Worker('test', async (job) => {
console.log('Processing:', job.data);
return { success: true };
}, { embedded: true });
await queue.add('hello', { message: 'bunqueue is working!' });

You should see Processing: { message: "bunqueue is working!" }. Next: the Quick Start builds on this.

To check the server and CLI:

Terminal window
bunqueue --version
bunqueue start

Each release ships self-contained executables, useful on servers and edge devices (Raspberry Pi, ARM64 boxes) where you don’t want to install a runtime:

Terminal window
# Platforms: linux-x64 | linux-arm64 | darwin-x64 | darwin-arm64 (windows-x64 ships as a .zip)
curl -fsSLO https://github.com/egeominotti/bunqueue/releases/latest/download/bunqueue-linux-arm64.tar.gz
tar -xzf bunqueue-linux-arm64.tar.gz
sudo mv bunqueue-linux-arm64 /usr/local/bin/bunqueue
bunqueue start --data-path /var/lib/bunqueue/queue.db

A SHA256SUMS file is attached to every release for checksum verification.

The binary is the full server + CLI. For the client SDK in your app code you still install the package (bun add bunqueue).

Terminal window
git clone https://github.com/egeominotti/bunqueue.git
cd bunqueue
bun install
bun run build

bunqueue is written in TypeScript and ships full type definitions:

import type {
Job,
JobOptions,
WorkerOptions,
StallConfig,
DlqConfig,
DlqEntry
} from 'bunqueue/client';