Install bunqueue — Setup Guide for Bun Job Queue

Requirements

Bun v1.3.9 or later (enforced via engines)

Install from npm

bun add bunqueue

Install from source

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

Single binary (no Bun required)

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

# Pick your platform: linux-x64 | linux-arm64 | darwin-x64 | darwin-arm64
curl -fsSLO https://github.com/egeominotti/bunqueue/releases/latest/download/bunqueue-linux-arm64.tar.gz
tar -xzf bunqueue-linux-arm64.tar.gz
./bunqueue-linux-arm64 --version
sudo mv bunqueue-linux-arm64 /usr/local/bin/bunqueue

bunqueue start --data-path /var/lib/bunqueue/queue.db

Checksums: SHA256SUMS is attached to every release.

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

Verify Installation

Embedded Mode

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!' });

Server Mode

# Start server
bunqueue start

# Check version
bunqueue --version

TypeScript Support

bunqueue is written in TypeScript and includes full type definitions:

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

Next Steps

Quick Start - Create your first queue and worker