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

engine

package

Go to main page

Versions in this module

v0

v0.5.1

Apr 9, 2026

v0.5.0

Apr 5, 2026

Changes in this version

type Result

+ DryRun bool

type Summary

+ CopyPlanned int

v0.4.4

Apr 3, 2026

v0.4.3

Apr 3, 2026

v0.4.2

Mar 24, 2026

v0.4.1

Mar 5, 2026

v0.4.0

Mar 5, 2026

v0.3.0

Mar 5, 2026

v0.2.1

Mar 1, 2026

Changes in this version

+ const IncludeMissingHintSourceMissing

+ const IncludeMissingHintSourceMissingTargetExists

+ const IncludeOriginExplicit

+ const IncludeOriginSource

type DoctorReport

+ IncludeMissingHint string

v0.2.0

Mar 1, 2026

Changes in this version

type DoctorReport

+ IncludeHint string

+ IncludeOrigin string

+ TargetIncludePath string

type Result

+ IncludeFound bool

+ IncludeMissingHint string

+ IncludeOrigin string

+ PatternCount int

+ ResolvedIncludePath string

+ TargetIncludePath string

v0.1.0

Mar 1, 2026

Changes in this version

+ type Action struct

+ Op string

+ Path string

+ Status string

+ type ApplyOptions struct

+ DryRun bool

+ Force bool

+ From string

+ Include string

+ type CLIError struct

+ Code int

+ Err error

+ Msg string

+ func (e *CLIError) Error() string

+ func (e *CLIError) Unwrap() error

+ type DoctorOptions struct

+ From string

+ Include string

+ type DoctorReport struct

+ FromMode string

+ IncludeFound bool

+ IncludePath string

+ PatternCount int

+ Result Result

+ SourceRoot string

+ TargetRoot string

+ type Engine struct

+ func NewEngine() *Engine

+ func (e *Engine) Apply(ctx context.Context, cwd string, opts ApplyOptions) (Result, int, error)

+ func (e *Engine) Doctor(ctx context.Context, cwd string, opts DoctorOptions) (DoctorReport, error)

+ func (e *Engine) HookPath(ctx context.Context, cwd string, absolute bool) (string, error)

+ type Result struct

+ Actions []Action

+ From string

+ IncludeFile string

+ Summary Summary

+ To string

+ type Summary struct

+ Conflicts int

+ Copied int

+ Errors int

+ Matched int

+ SkippedMissingSrc int

+ SkippedSame int