Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions internal/beads/beads.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
// Package beads provides a wrapper for the bd (beads) CLI.
// Use New() to create a Beads instance for a working directory, then call
// methods like List(), Show(), Create(), Update(), and Close() to manage issues.
package beads

import (
Expand Down Expand Up @@ -117,6 +119,8 @@ type Beads struct {
}

// New creates a new Beads wrapper for the given directory.
// This is the main entry point for interacting with the beads CLI programmatically.
// The workDir should be a directory containing or inheriting a .beads database.
func New(workDir string) *Beads {
return &Beads{workDir: workDir}
}
Expand Down
Loading