gitsync

Documentation

Index

• type SyncResult
• type Syncer
  • func NewSyncer(vaultPath, remote string) *Syncer
  • func (s *Syncer) Pull() error
  • func (s *Syncer) Status() ([]string, error)
  • func (s *Syncer) Sync() (*SyncResult, error)

Types

type SyncResult

type SyncResult struct {
	FilesChanged int
	CommitHash   string
	Pushed       bool
	Message      string
}

SyncResult holds the result of a sync operation.

type Syncer

type Syncer struct {
	VaultPath string
	Remote    string
	AuthToken string
}

Syncer handles git synchronization for the vault.

func NewSyncer

func NewSyncer(vaultPath, remote string) *Syncer

NewSyncer creates a new Syncer.

func (*Syncer) Pull

func (s *Syncer) Pull() error

Pull fetches and merges remote changes.

func (*Syncer) Status

func (s *Syncer) Status() ([]string, error)

Status returns a list of changed file paths.

func (*Syncer) Sync

func (s *Syncer) Sync() (*SyncResult, error)

Sync commits local changes and optionally pushes them to the remote.