hooks

package

v0.62.1 Latest Latest Go to latest Published: Mar 13, 2026 License: MIT Imports: 15 Imported by: 0

Details

Rendered for

Package hooks provides a hook system for extensibility. Hooks are executable scripts in .beads/hooks/ that run after certain events.

View Source

const (
	EventCreate = "create"
	EventUpdate = "update"
	EventClose  = "close"
)

Event types

View Source

const (
	HookOnCreate = "on_create"
	HookOnUpdate = "on_update"
	HookOnClose  = "on_close"
)

Hook file names

This section is empty.

This section is empty.

type Runner struct {
	// contains filtered or unexported fields
}

Runner handles hook execution

func NewRunner(hooksDir string) *Runner

NewRunner creates a new hook runner. hooksDir is typically .beads/hooks/ relative to workspace root.

func NewRunnerFromWorkspace(workspaceRoot string) *Runner

NewRunnerFromWorkspace creates a hook runner for a workspace.

func (r *Runner) HookExists(event string) bool

HookExists checks if a hook exists for an event

func (r *Runner) Run(event string, issue *types.Issue)

Run executes a hook if it exists. Runs asynchronously - returns immediately, hook runs in background.

func (r *Runner) RunSync(event string, issue *types.Issue) error

RunSync executes a hook synchronously and returns any error. Useful for testing or when you need to wait for the hook.