We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 9b2a1c4 commit c655552Copy full SHA for c655552
1 file changed
internal/beads/beads.go
@@ -1,4 +1,14 @@
1
-// Package beads provides a wrapper for the bd (beads) CLI.
+// Package beads provides a Go wrapper for the bd (beads) CLI tool.
2
+//
3
+// The beads package enables Gas Town components to interact with the beads
4
+// issue tracking system programmatically. It wraps the bd CLI commands and
5
+// provides typed Go interfaces for common operations like listing issues,
6
+// creating/updating issues, managing dependencies, and syncing with remote.
7
8
+// The main type is [Beads], which is constructed with a working directory
9
+// and provides methods for all bd operations. Use [New] for normal usage,
10
+// [NewIsolated] for test isolation, or [NewWithBeadsDir] when accessing
11
+// beads from a different directory than the working directory.
12
package beads
13
14
import (
0 commit comments