beadwork

module
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 11, 2026 License: MIT

README

Beadwork

CI coverage

Git-native work management for AI coding agents.

Why

AI coding agents lose context constantly — compaction, session boundaries, crashes. Plans they build in-context die silently. The agent picks up where it left off with no memory of what it decided or why.

Beadwork gives agents durable state in git. Plans, progress, and decisions persist as files on a git branch. Nothing touches your working tree. Two agents working on the same repo never touch the same file. Sync is just git push.

What It Looks Like

You talk to your agent normally. Beadwork works behind the scenes.

  • "Plan the auth module refactor"
  • "What's next?"
  • "Continue where we left off"
  • "Use a team to do bw-xyz and bw-abc"

Community

Join the Beadwork Discord for discussion, support, and updates.

Install

curl -fsSL https://raw.githubusercontent.com/jallum/beadwork/main/install.sh | sh

Or download a binary from releases. To update an existing install: bw upgrade.

Coming from beads? see docs/migration.md.

Quick Start

bw init                                           # initialize in any git repo
bw onboard                                        # print bootstrap snippet for CLAUDE.md / GEMINI.md
bw create "Fix auth bug" --type bug -p 1          # create an issue
bw ready                                          # list unblocked work
bw comment bw-a1b2 "Fixed in latest deploy"       # add a comment
bw close bw-a1b2                                  # close it
bw sync                                           # push to remote

Commands

Managing Work

bw create <title> [flags]           Create an issue (--parent, --type, -p, --silent)
bw show <id>... [--only <sections>] [--json]  Show issue details with deps (aliases: view)
bw list [filters] [--json]          List issues (--grep, --all, --deferred)
bw update <id> [flags]              Update an issue (--parent to set/clear)
bw close <id> [--reason <r>]        Close an issue
bw reopen <id>                      Reopen a closed issue
bw delete <id> [--force]            Delete an issue (preview by default)
bw comment <id> <text>              Add a comment (--author; use bw show to view)
bw label <id> +lab [-lab] ...       Add/remove labels
bw defer <id> <date>                Defer until a date
bw undefer <id>                     Restore a deferred issue
bw history <id> [--limit N]         Show commit history for an issue

Finding Work

bw ready [--json]              List unblocked issues
bw blocked [--json]            List issues waiting on dependencies

Dependencies

bw dep add <id> blocks <id>    Add a dependency
bw dep remove <id> blocks <id> Remove a dependency

Sync & Data

bw sync                        Fetch, rebase/replay, push
bw export [--status <s>]       Export issues as JSONL
bw import <file> [--dry-run]   Import issues from JSONL (use - for stdin)

Setup & Config

bw init [--prefix] [--force]   Initialize beadwork
bw config get|set|list         View/set config options
bw upgrade [--check] [--yes]   Check for / install binary updates
bw upgrade repo                Upgrade repo schema to latest version
bw onboard                     Print agent instructions snippet
bw prime                       Print workflow context for agents

Agent Integration

bw onboard prints a snippet for your project's agent instructions file (CLAUDE.md, GEMINI.md, etc.). Once installed, agents automatically load workflow context via bw prime at the start of each session.

Design

All data lives on a git orphan branch, manipulated directly in the object database via go-git. Every operation is an atomic commit. Sync uses fetch-rebase-push with intent replay on conflict.

For storage layout and sync mechanics, see docs/design.md.

Contributing

See CONTRIBUTING.md for the local dev loop and make targets that mirror CI.

License

MIT

Directories

Path Synopsis
cmd
bw command
internal
agent
Package agent detects which AI coding agent (if any) is invoking the current process.
Package agent detects which AI coding agent (if any) is invoking the current process.
config
Package config provides a lightweight global configuration backed by a YAML file (~/.bw by default, overridden by $BW_CONFIG).
Package config provides a lightweight global configuration backed by a YAML file (~/.bw by default, overridden by $BW_CONFIG).
md
Package md produces tokenized markdown output for beadwork commands.
Package md produces tokenized markdown output for beadwork commands.
recap
Package recap builds structured activity summaries from beadwork commit history.
Package recap builds structured activity summaries from beadwork commit history.
registry
Package registry provides config-backed helpers for the host-local repository registry (the registry.repos key in the global config).
Package registry provides config-backed helpers for the host-local repository registry (the registry.repos key in the global config).
tmpl
Package tmpl wraps Go text/template for beadwork prompt rendering.
Package tmpl wraps Go text/template for beadwork prompt rendering.
treefs
Package treefs provides a mutable, filesystem-like API backed by git tree objects.
Package treefs provides a mutable, filesystem-like API backed by git tree objects.
wrap
Package wrap provides text line-wrapping utilities.
Package wrap provides text line-wrapping utilities.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL