Skip to main content
ClaudeWave
EN, English
Slash Command262 repo starsupdated 7mo ago

beads-init

The beads-init command sets up Beads issue tracking in a project through interactive configuration, checking for the Beads CLI installation, prompting users to select a configuration type (base, full, or stealth), requesting a project prefix, and automating the initialization process including copying templates, updating configuration files, and performing an initial sync. Use this command when starting a new project that needs structured issue and task management integrated with Git workflows.

Install in Claude Code
Copy
mkdir -p ~/.claude/commands && curl -fsSL https://raw.githubusercontent.com/maslennikov-ig/claude-code-orchestrator-kit/HEAD/.claude/commands/beads-init.md -o ~/.claude/commands/beads-init.md
Then start a new Claude Code session; the slash command loads automatically.

beads-init.md

# Beads Initialization

> **Attribution**: [Beads](https://github.com/steveyegge/beads) is created by [Steve Yegge](https://github.com/steveyegge).

## User Input

```text
$ARGUMENTS
```

## Prerequisites Check

First, verify Beads CLI is installed:

```bash
bd version
```

If not installed, provide installation options:

**Option 1: Go (recommended)**
```bash
go install github.com/steveyegge/beads/cmd/bd@latest
```

**Option 2: npm**
```bash
npm install -g @beads/bd
```

**Option 3: Homebrew (macOS)**
```bash
brew install steveyegge/tap/beads
```

## Configuration Selection

Ask user to choose configuration:

1. **base** - Minimal setup, good for getting started
2. **full** - All features enabled (recommended for production)
3. **stealth** - Local-only mode, no auto-push to remote

## Project Prefix

Ask user for their issue prefix (3-8 characters, lowercase):
- Should be short project name
- All issues will be `PREFIX-xxx`
- Examples: `myapp`, `web`, `api`, `proj`

## Initialization Steps

1. **Initialize Beads**:
```bash
bd init
```

2. **Copy configuration** (based on user choice):
```bash
cp .beads-templates/config/{chosen}.yaml .beads/config.yaml
```

3. **Update issue-prefix** in config.yaml with user's chosen prefix

4. **Copy formulas**:
```bash
mkdir -p .beads/formulas
cp .beads-templates/formulas/*.toml .beads/formulas/
```

5. **Copy PRIME template**:
```bash
cp .beads-templates/PRIME.template.md .beads/PRIME.md
```

6. **Update PRIME.md** - replace `{{PREFIX}}` and `{{PROJECT_NAME}}`

7. **Initial sync**:
```bash
bd sync
```

## Post-Setup Instructions

After initialization, display:

```
## Beads Initialized!

**Prefix**: {PREFIX}
**Config**: {CONFIG_TYPE}

### Quick Start

1. Create your first task:
   bd create "Setup project" -t chore -p 3

2. View available work:
   bd ready

3. Start working:
   bd update {PREFIX}-xxx --status in_progress

4. Complete task:
   bd close {PREFIX}-xxx --reason "Done"

### Session Workflow

START:  bd prime → bd ready
WORK:   bd update → work → bd close → /push patch
END:    bd sync → git push

### Documentation

- Quick reference: .claude/docs/beads-quickstart.md
- Templates: .beads-templates/README.md
- Official docs: https://github.com/steveyegge/beads

### Next Steps

- [ ] Review .beads/config.yaml and customize directory-labels
- [ ] Create REF: issues for project knowledge (optional)
- [ ] Run /speckit.tobeads after generating tasks.md
```

## Troubleshooting

If bd init fails:
- Check if .beads/ already exists
- Try: `rm -rf .beads && bd init`

If daemon doesn't start:
- Check logs: `cat .beads/daemon.log`
- Restart: `bd daemon restart`

## Example Session

```
User: /beads-init
algorithmic-artSkill

Creating algorithmic art using p5.js with seeded randomness and interactive parameter exploration. Use this when users request creating art using code, generative art, algorithmic art, flow fields, or particle systems. Create original algorithmic art rather than copying existing artists' work to avoid copyright violations.

artifacts-builderSkill

Suite of tools for creating elaborate, multi-component claude.ai HTML artifacts using modern frontend web technologies (React, Tailwind CSS, shadcn/ui). Use for complex artifacts requiring state management, routing, or shadcn/ui components - not for simple single-file HTML/JSX artifacts.

beadsSkill
calculate-priority-scoreSkill

Calculate priority score for bugs, issues, or tasks based on severity, impact, and likelihood. Use for bug prioritization, task ordering, or risk assessment.

canvas-designSkill

Create beautiful visual art in .png and .pdf documents using design philosophy. You should use this skill when the user asks to create a poster, piece of art, design, or other static piece. Create original visual designs, never copying existing artists' work to avoid copyright violations.

changelog-generatorSkill

Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.

cleanup-health-inlineSkill

Inline orchestration workflow for dead code detection and removal with Beads integration. Provides step-by-step phases for dead-code-hunter detection, priority-based cleanup with dead-code-remover, and verification cycles.

code-reviewSkill

Analyzes code changes for bugs, security vulnerabilities, performance problems, and architectural improvements. Generates structured markdown reports with evidence-based findings tied to specific file:line references, and creates Beads tasks for tracking. Adapts review depth based on scope — from quick pre-commit checks to thorough branch reviews. Use proactively when reviewing code before commits, after implementing features, before PRs, when checking code quality, or when the user mentions "review", "check changes", "code review", "PR review", "review branch", or any code quality assessment.