Documentation
ΒΆ
Overview ΒΆ
Package beads provides a minimal public API for extending bd with custom orchestration.
Most extensions should use direct SQL queries against bd's database. This package exports only the essential types and functions needed for Go-based extensions that want to use bd's storage layer programmatically.
For detailed guidance on extending bd, see docs/EXTENDING.md.
Index ΒΆ
- Constants
- func FindBeadsDir() string
- func FindDatabasePath() string
- func FindJSONLPath(dbPath string) string
- type BlockedIssue
- type Comment
- type DatabaseInfo
- type Dependency
- type DependencyCounts
- type DependencyType
- type EpicStatus
- type Event
- type EventType
- type Issue
- type IssueFilter
- type IssueType
- type IssueWithCounts
- type Label
- type RedirectInfo
- type SortPolicy
- type StaleFilter
- type Status
- type Storage
- type Transaction
- type TreeNode
- type WorkFilter
Constants ΒΆ
const ( StatusOpen = types.StatusOpen StatusInProgress = types.StatusInProgress StatusBlocked = types.StatusBlocked StatusDeferred = types.StatusDeferred StatusClosed = types.StatusClosed )
Status constants
const ( TypeBug = types.TypeBug TypeFeature = types.TypeFeature TypeTask = types.TypeTask TypeEpic = types.TypeEpic TypeChore = types.TypeChore )
IssueType constants
const ( DepBlocks = types.DepBlocks DepRelated = types.DepRelated DepParentChild = types.DepParentChild DepDiscoveredFrom = types.DepDiscoveredFrom DepConditionalBlocks = types.DepConditionalBlocks // B runs only if A fails (bd-kzda) )
DependencyType constants
const ( SortPolicyHybrid = types.SortPolicyHybrid SortPolicyPriority = types.SortPolicyPriority SortPolicyOldest = types.SortPolicyOldest )
SortPolicy constants
const ( EventCreated = types.EventCreated EventUpdated = types.EventUpdated EventStatusChanged = types.EventStatusChanged EventCommented = types.EventCommented EventClosed = types.EventClosed EventReopened = types.EventReopened EventDependencyAdded = types.EventDependencyAdded EventDependencyRemoved = types.EventDependencyRemoved EventLabelAdded = types.EventLabelAdded EventLabelRemoved = types.EventLabelRemoved EventCompacted = types.EventCompacted )
EventType constants
Variables ΒΆ
This section is empty.
Functions ΒΆ
func FindBeadsDir ΒΆ
func FindBeadsDir() string
FindBeadsDir finds the .beads/ directory in the current directory tree Returns empty string if not found. Supports both database and JSONL-only mode.
func FindDatabasePath ΒΆ
func FindDatabasePath() string
FindDatabasePath finds the beads database in the current directory tree
func FindJSONLPath ΒΆ
FindJSONLPath finds the JSONL file corresponding to a database path
Types ΒΆ
type DatabaseInfo ΒΆ
type DatabaseInfo = beads.DatabaseInfo
DatabaseInfo contains information about a beads database
func FindAllDatabases ΒΆ
func FindAllDatabases() []DatabaseInfo
FindAllDatabases finds all beads databases in the system
type DependencyCounts ΒΆ
type DependencyCounts = types.DependencyCounts
Core types from internal/types
type RedirectInfo ΒΆ
type RedirectInfo = beads.RedirectInfo
RedirectInfo contains information about a beads directory redirect
func GetRedirectInfo ΒΆ
func GetRedirectInfo() RedirectInfo
GetRedirectInfo checks if the current beads directory is redirected. Returns RedirectInfo with IsRedirected=true if a redirect is active.
type Transaction ΒΆ
type Transaction = beads.Transaction
Transaction provides atomic multi-operation support within a database transaction. Use Storage.RunInTransaction() to obtain a Transaction instance.
Directories
ΒΆ
| Path | Synopsis |
|---|---|
|
_LEGACY
|
|
|
beads-legacy/cmd/bd
command
|
|
|
_rules
|
|
|
_evals
command
|
|
|
cmd
|
|
|
bd
command
Package main provides the CommandContext struct that consolidates runtime state.
|
Package main provides the CommandContext struct that consolidates runtime state. |
|
bd/doctor
Package doctor provides health check and repair functionality for beads.
|
Package doctor provides health check and repair functionality for beads. |
|
internal
|
|
|
beads
Package beads provides a minimal public API for extending bd with custom orchestration.
|
Package beads provides a minimal public API for extending bd with custom orchestration. |
|
compact
Package compact provides AI-powered issue compaction using Claude Haiku.
|
Package compact provides AI-powered issue compaction using Claude Haiku. |
|
formula
Package formula provides advice operators for step transformations.
|
Package formula provides advice operators for step transformations. |
|
hooks
Package hooks provides a hook system for extensibility.
|
Package hooks provides a hook system for extensibility. |
|
linear
Package linear provides client and data types for the Linear GraphQL API.
|
Package linear provides client and data types for the Linear GraphQL API. |
|
molecules
Package molecules handles loading template molecules from molecules.jsonl catalogs.
|
Package molecules handles loading template molecules from molecules.jsonl catalogs. |
|
recipes
Package recipes provides recipe-based configuration for bd setup.
|
Package recipes provides recipe-based configuration for bd setup. |
|
storage
Package storage defines the interface for issue storage backends.
|
Package storage defines the interface for issue storage backends. |
|
storage/memory
Package memory implements the storage interface using in-memory data structures.
|
Package memory implements the storage interface using in-memory data structures. |
|
storage/sqlite
Package sqlite provides the blocked_issues_cache optimization for GetReadyWork performance.
|
Package sqlite provides the blocked_issues_cache optimization for GetReadyWork performance. |
|
syncbranch
Package syncbranch provides sync branch configuration and integrity checking.
|
Package syncbranch provides sync branch configuration and integrity checking. |
|
testutil/fixtures
Package fixtures provides realistic test data generation for benchmarks and tests.
|
Package fixtures provides realistic test data generation for benchmarks and tests. |
|
timeparsing
Package timeparsing provides layered time parsing for relative date/time expressions.
|
Package timeparsing provides layered time parsing for relative date/time expressions. |
|
types
Package types defines core data structures for the bd issue tracker.
|
Package types defines core data structures for the bd issue tracker. |
|
ui
Package ui provides terminal styling for beads CLI output.
|
Package ui provides terminal styling for beads CLI output. |
|
utils
Package utils provides utility functions for issue ID parsing and resolution.
|
Package utils provides utility functions for issue ID parsing and resolution. |