Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Beads Documentation home page

GitHub
npm

Getting Started

Introduction
Installation
Quick Start
IDE Setup
Sync Setup Guide
Upgrading

Core Concepts

How Beads Works
Issues & Dependencies
Dependencies and Gates
Hash-based IDs
Adaptive ID Length
Graph Links in Beads
Sync Concepts
Labels
Issue Metadata

Architecture

Architecture Overview
Dolt Backend for Beads

Workflows

Workflows
Molecules
Formulas
Gates
Wisps
TODO Command

Recovery

Recovery Overview
Accidental v1.2.1 Release
Recovery Playbooks
Database Corruption
Merge Conflicts
Circular Dependencies
Sync Failures
History Bloat
Uninstalling

Multi-Agent

Multi-Agent
Multi-Repo Routing
Agent Coordination
Federation Setup Guide
Bucket Federation Quickstart
Multi-Repo Migration Guide

Integrations

Integrations
Aider
Claude Code
Beads Claude Code Plugin
Codex
Sourcegraph Cody
Cursor
Factory.ai Droid
Gemini CLI
Junie
Kilo Code
Kiro CLI
Mux
OpenCode
Windsurf
MCP Server
GitHub Copilot
GitHub Copilot CLI Integration Design
Azure DevOps (ADO) Integration Configuration

Community

Community Tools
Related Projects

Reference

Reference
Configuration
Git Integration
Git Worktrees Guide
Protected Branches
Advanced Features
JSON Output Schema Contract
Events Journal
Observability (OpenTelemetry)
Troubleshooting
Antivirus False Positives
FAQ

CLI Reference

bd quickstart

Display a quick start guide showing common bd workflows and patterns.

Generated from bd help --doc quickstart. Display a quick start guide showing common bd workflows and patterns.

bd quickstart [flags]

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform