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
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

worktree

package

Go to main page

Versions in this module

v0

v0.18.1

May 27, 2026

v0.18.0

May 27, 2026

Changes in this version

type CreateResult

+ func CreateAnchoredWorktreeForBranch(ctx *app.Context, branchName string, name string, scope string) (*CreateResult, error)

type Entry

+ CanDetach bool

+ CanRemove bool

+ IsCurrent bool

+ NeedsRepair bool

+ RegistrationState RegistrationState

+ RootBranches []string

+ StatusMessage string

type ListOptions

+ NameOrBranch string

+ type RegistrationState string

+ const RegistrationStateInvalid

+ const RegistrationStateLegacy

+ const RegistrationStateOK

+ type RepairEntry struct

+ Action string

+ AnchorBranch string

+ Name string

+ type RepairOptions struct

+ NameOrBranch string

+ type RepairResult struct

+ Repaired []RepairEntry

+ Skipped []SkippedEntry

+ func RepairAction(ctx *app.Context, opts RepairOptions) (*RepairResult, error)

v0.17.15

May 11, 2026

v0.17.14

May 11, 2026

Changes in this version

+ const HookTimeout

+ func DetachAction(ctx *app.Context, opts DetachOptions) error

+ func OpenAction(ctx *app.Context, opts OpenOptions) (string, error)

+ func RemoveAction(ctx *app.Context, opts RemoveOptions) error

+ func ResolveApprovedHooks(ctx *app.Context) ([]string, error)

+ func RunPostCreateHooks(ctx *app.Context, worktreePath string) error

+ func RunResolvedHooks(hooks []string, worktreePath string, out output.Output)

+ type AttachOptions struct

+ Branch string

+ Name string

+ type AttachResult struct

+ AnchorBranch string

+ Name string

+ Path string

+ func AttachAction(ctx *app.Context, opts AttachOptions) (*AttachResult, error)

+ type CreateOptions struct

+ Name string

+ Scope string

+ type CreateResult struct

+ AnchorBranch string

+ Name string

+ Path string

+ func CreateAction(ctx *app.Context, opts CreateOptions) (*CreateResult, error)

+ type DetachOptions struct

+ Force bool

+ NameOrBranch string

+ type Entry struct

+ AnchorBranch string

+ CurrentBranch string

+ Exists bool

+ IsDirty bool

+ Name string

+ Path string

+ StackSize int

+ type ListOptions struct

+ type ListResult struct

+ CurrentAnchor string

+ Worktrees []Entry

+ func ListAction(ctx *app.Context, _ ListOptions) (*ListResult, error)

+ type OpenOptions struct

+ AnchorBranch string

+ type PruneOptions struct

+ DryRun bool

+ type PruneResult struct

+ Pruned []string

+ Skipped []SkippedEntry

+ func PruneAction(ctx *app.Context, opts PruneOptions) (*PruneResult, error)

+ type RemoveOptions struct

+ AnchorBranch string

+ Force bool

+ KeepBranch bool

+ type SkippedEntry struct

+ Name string

+ Reason string