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

sync

package

Go to main page

Versions in this module

v0

v0.10.0

Apr 26, 2026

Changes in this version

type ApplyOptions

+ SourcePathDisplay func(string) string

+ TargetPathDisplay func(string) string

type PathSpec

+ func ParsePathSpecWithHosts(arg string, knownHosts []string) (PathSpec, error)

type SyncConnect

+ Closer io.Closer

+ func (s *SyncConnect) Close() error

type SyncInfo

+ DisplayPath []string

v0.9.0

Apr 12, 2026

Changes in this version

+ func BuildBidirectionalPlans(leftFS FileSystem, rightFS FileSystem, leftRoot string, rightRoot string) (*Plan, *Plan, error)

+ func RunDaemonLoop(ctx context.Context, interval time.Duration, fn func(context.Context) error) error

type ApplyOptions

+ DryRun bool

+ SourceLabel string

+ TargetLabel string

type CommandArgs

+ Bidirectional bool

+ Daemon bool

+ DaemonInterval time.Duration

+ DryRun bool

type Sync

+ Bidirectional bool

+ ControlMasterOverride *bool

+ Daemon bool

+ DaemonInterval time.Duration

+ DryRun bool

v0.8.0

Apr 8, 2026

Changes in this version

+ func ApplyPlan(ctx context.Context, srcFS FileSystem, dstFS FileSystem, plan *Plan, ...) error

+ type ApplyOptions struct

+ Delete bool

+ Output *output.Output

+ ParallelNum int

+ Permission bool

+ type CommandArgs struct

+ Delete bool

+ Destination string

+ ParallelNum int

+ Permission bool

+ Sources []string

+ func ParseCommandArgs(args []string) (CommandArgs, error)

+ type DeleteScope struct

+ IsDir bool

+ Path string

+ type DesiredEntry struct

+ DestinationPath string

+ IsDir bool

+ ModTime time.Time

+ Mode fs.FileMode

+ RelPath string

+ Size int64

+ SourcePath string

+ type FileSystem interface

+ Chmod func(path string, mode fs.FileMode) error

+ Chtimes func(path string, atime, mtime time.Time) error

+ Clean func(path string) string

+ Dir func(path string) string

+ Expand func(raw string) ([]string, error)

+ Join func(elem ...string) string

+ MkdirAll func(path string) error

+ Open func(path string) (io.ReadCloser, error)

+ OpenWriter func(path string, perm fs.FileMode) (io.WriteCloser, error)

+ Remove func(path string) error

+ RemoveDir func(path string) error

+ Resolve func(raw string) (string, error)

+ Separator func() string

+ Stat func(path string) (fs.FileInfo, error)

+ Walk func(root string, fn func(path string, info fs.FileInfo) error) error

+ func NewLocalFS() (FileSystem, error)

+ func NewRemoteFS(client *sftp.Client, pwd string) FileSystem

+ type PathSpec struct

+ Hosts []string

+ IsRemote bool

+ Path string

+ Raw string

+ func ParsePathSpec(arg string) (PathSpec, error)

+ type Plan struct

+ DeleteScopes []DeleteScope

+ Desired map[string]DesiredEntry

+ func BuildPlan(srcFS FileSystem, dstFS FileSystem, sourceArgs []string, destination string) (*Plan, error)

+ type Sync struct

+ Config conf.Config

+ Delete bool

+ From SyncInfo

+ ParallelNum int

+ Permission bool

+ Progress *mpb.Progress

+ ProgressWG *syncpkg.WaitGroup

+ Run *sshl.Run

+ To SyncInfo

+ func (s *Sync) Start()

+ type SyncConnect struct

+ Connect *sftp.Client

+ Output *output.Output

+ Pwd string

+ Server string

+ type SyncInfo struct

+ IsRemote bool

+ Path []string

+ Server []string