DebugBundle

CLI

The CLI is the primary tool for local workflows, project setup, and cloud management.

npm install -g @debugbundle/cli

Verify the installation:

debugbundle --version

Node.js SDK

npm install @debugbundle/sdk-node

import DebugBundle from '@debugbundle/sdk-node';

DebugBundle.init({
  projectToken: 'local',    // or your project token for connected mode
  environment: 'production',
  service: 'my-api',
});

The Node.js SDK includes subpath exports for framework integrations and browser relay handlers:

Import	Purpose
`@debugbundle/sdk-node`	Core SDK
`@debugbundle/sdk-node/relay`	Generic relay handler
`@debugbundle/sdk-node/relay/express`	Express relay middleware
`@debugbundle/sdk-node/relay/fastify`	Fastify relay plugin
`@debugbundle/sdk-node/relay/nextjs`	Next.js API route relay

Browser SDK

Via npm:

npm install @debugbundle/sdk-browser

import DebugBundle from '@debugbundle/sdk-browser';

DebugBundle.init({
  projectToken: 'dbundle_proj_...',
  environment: 'production',
  service: 'my-frontend',
  relayUrl: '/debugbundle/browser',  // same-origin relay endpoint
});

Browser events are shipped through a same-origin relay handler on your backend — not directly to the DebugBundle API. See Browser Relay Setup for configuration.

Python SDK

pip install debugbundle

import debugbundle

debugbundle.init(
    project_token="local",
    environment="production",
    service="my-api",
)

Framework integrations for Django, Flask, and FastAPI are included. See the Python SDK guide.

PHP SDK

composer require debugbundle/sdk-php

\DebugBundle\SDK::init([
    'projectToken' => 'local',
    'environment' => 'production',
    'service' => 'my-api',
]);

Framework integrations for Laravel and Symfony are included. See the PHP SDK guide.

Self-Hosting

DebugBundle can be self-hosted with Docker Compose. This gives you a fully functional instance with no external dependencies and no usage limits.

Prerequisites

Docker and Docker Compose
2 GB RAM minimum
Ports 5291 (web), 3004 (API), 5434 (PostgreSQL), 6380 (Redis), and 4567 (LocalStack) available

Quick Start

git clone https://github.com/debugbundle/debugbundle.git
cd debugbundle/deploy/selfhost
cp .env.example .env  # edit with your settings
docker compose up -d

The self-host stack includes:

Service	Port	Purpose
Web	5291	Dashboard SPA
API	3004	HTTP API
Worker	—	Background processing
PostgreSQL	5434	Metadata storage
Redis	6380	Job queue
LocalStack S3	4567	Object storage

See the Self-Hosting Guide for environment variables, health checks, backups, and upgrade procedures.

Next Steps

Quickstart — Your first debug bundle in under 5 minutes
Node.js SDK — Full configuration and framework integration guide
Browser SDK — Breadcrumbs, network capture, session controls
CLI Setup — Project scaffolding and configuration

Installation

CLI