kbeads

module
v0.3.16 Latest Latest
Warning

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

Go to latest
Published: Feb 26, 2026 License: MIT

README

Beads

An event-driven work-tracking system. Manages hierarchical work items ("beads") with dependencies, labels, comments, and event history. Exposes gRPC and REST APIs and ships a Cobra-based CLI (kd).

Quick start

go build ./cmd/kd

export BEADS_DATABASE_URL="postgres://user:pass@localhost:5432/beads?sslmode=disable"
kd serve

Or via Docker:

docker build -t kd .
docker run -e BEADS_DATABASE_URL="..." -p 9090:9090 -p 8080:8080 kd

CLI examples

kd create "Fix login bug" --type bug
kd list --status open
kd show kd-abc123
kd update kd-abc123 --status in_progress
kd close kd-abc123
kd comment kd-abc123 "Root cause was a nil pointer"
kd label kd-abc123 add backend
kd dep kd-abc123 add kd-def456
kd search "login"

Custom types can be registered at runtime:

kd config create type:decision '{"kind":"issue","fields":[{"name":"outcome","type":"enum","values":["approved","rejected","pending"],"required":true}]}'
kd create "Approve Q1 roadmap" --type decision --fields '{"outcome":"pending"}'

Configuration

Variable Default Purpose
BEADS_DATABASE_URL (required) Postgres connection string
BEADS_GRPC_ADDR :9090 gRPC listen address
BEADS_HTTP_ADDR :8080 HTTP listen address
BEADS_NATS_URL (optional) NATS event bus URL
BEADS_SERVER localhost:9090 CLI client target address

Testing

go test ./...    # uses go-sqlmock; no running Postgres needed

Directories

Path Synopsis
cmd
kd command
gen
internal
client
Package client provides a transport-agnostic interface for the kbeads service and an HTTP/JSON implementation that talks to the kbeads REST API.
Package client provides a transport-agnostic interface for the kbeads service and an HTTP/JSON implementation that talks to the kbeads REST API.
hooks
Package hooks provides advice hook execution for session lifecycle events.
Package hooks provides advice hook execution for session lifecycle events.
idgen
Package idgen provides short, URL-safe unique ID generation backed by nanoid.
Package idgen provides short, URL-safe unique ID generation backed by nanoid.
presence
Package presence tracks live agent activity for the agent roster.
Package presence tracks live agent activity for the agent roster.
store/postgres
Package postgres implements the store.Store interface backed by PostgreSQL.
Package postgres implements the store.Store interface backed by PostgreSQL.
ui

Jump to

Keyboard shortcuts

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