Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

goal

package

Go to main page

Versions in this module

v0

v0.3.1

Aug 2, 2026

v0.3.0

Jul 31, 2026

v0.2.2

Jun 14, 2026

Changes in this version

+ func BudgetLimitPrompt(state State) string

+ func ContinuationPrompt(state State) string

+ func StartPrompt(state State) string

+ func ValidateStatus(status Status) error

+ type Change struct

+ Current State

+ Previous State

+ type ChangeReceiver interface

+ HandleGoalChange func(Change)

+ type Manager struct

+ func NewManager(receiver SignalReceiver, stateAppender StateAppender) *Manager

+ func (m *Manager) Block(reason string) (State, error)

+ func (m *Manager) Clear() (State, error)

+ func (m *Manager) Complete(reason string) (State, error)

+ func (m *Manager) Create(objective string) (State, error)

+ func (m *Manager) CreateWithBudget(objective string, tokenBudget int) (State, error)

+ func (m *Manager) Pause() (State, error)

+ func (m *Manager) Restore(state State) error

+ func (m *Manager) Resume() (State, error)

+ func (m *Manager) ResumeWithBudget(tokenBudget int) (State, error)

+ func (m *Manager) SetChangeHandler(fn func(Change))

+ func (m *Manager) SetSuspender(fn func() bool)

+ func (m *Manager) SetTokenCounter(fn func() int)

+ func (m *Manager) Snapshot() State

+ func (m *Manager) UsageLimit(reason string) (State, error)

+ type Signal struct

+ Active bool

+ Err error

+ Key string

+ Reminder string

+ type SignalReceiver interface

+ SetGoalSignal func(func() Signal)

+ type State struct

+ BlockedAt time.Time

+ BlockedAttemptTokenTotal int

+ BlockedCount int

+ BlockedReason string

+ BudgetLimitReported bool

+ BudgetLimitedAt time.Time

+ CompletedAt time.Time

+ CreatedAt time.Time

+ ID string

+ Objective string

+ Reason string

+ Status Status

+ TokenBudget int

+ TokenTotalAtLastAccount int

+ TokensUsed int

+ UpdatedAt time.Time

+ UsageLimitedAt time.Time

+ func StateFromEntry(entry storage.GoalStateEntry) State

+ func (s State) Active() bool

+ func (s State) Empty() bool

+ func (s State) Normalize() State

+ type StateAppender interface

+ AppendGoalState func(storage.GoalStateEntry) error

+ type Status string

+ const StatusActive

+ const StatusBlocked

+ const StatusBudgetLimited

+ const StatusComplete

+ const StatusOff

+ const StatusPaused

+ const StatusUsageLimited

+ type Store struct

+ func NewStore() *Store

+ func (s *Store) Replace(state State)

+ func (s *Store) Snapshot() State

+ type TokenCounter interface

+ TotalTokens func() int