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

scanner

package

Go to main page

Versions in this module

v1

v1.3.1

May 1, 2026

Changes in this version

type MultiGitStatus

+ func NewMultiGitStatus() *MultiGitStatus

+ func (m *MultiGitStatus) AddResult(path string, rs RepoStatus)

+ func (m *MultiGitStatus) Delete(path string)

+ func (m *MultiGitStatus) Get(path string) (RepoStatus, bool)

+ func (m *MultiGitStatus) Len() int

+ func (m *MultiGitStatus) Set(path string, rs RepoStatus)

+ func (m *MultiGitStatus) SortedRepoPaths() []string

v1.3.0

Apr 30, 2026

v1.2.0

Apr 23, 2026

v1.1.0

Apr 22, 2026

Changes in this version

+ func RepoInclusionReasons(rs RepoStatus) []string

type BranchStatus

+ func (b BranchStatus) LocalRemoteMismatchReasons() []string

v1.0.0

Apr 22, 2026

Changes in this version

+ type BranchLocation struct

+ Exists bool

+ HistoriesUnrelated bool

+ Incoming int

+ Name string

+ NewestUniqueUnix int64

+ Outgoing int

+ Ref string

+ TipHash string

+ TipUnix int64

+ UniqueCount int

+ type BranchStatus struct

+ Branch string

+ Detached bool

+ LocalBranches []LocalBranchRef

+ Locations []BranchLocation

+ NewestLocation string

+ func GitBranchStatus(d string) (BranchStatus, error)

+ func (b BranchStatus) HasLocalRemoteMismatch() bool

type Config

+ Branches struct{ ... }

+ Edit struct{ ... }

+ func (c *Config) AlwaysListBranch(name string) bool

+ func (c *Config) EditArgv(absRepo string) ([]string, error)

+ func (c *Config) ShouldHideLocalOnlyBranch(lb LocalBranchRef) bool

type Excluder

+ func (e Excluder) FilterPorcelainStatus(st PorcelainStatus) PorcelainStatus

+ type LocalBranchRef struct

+ Current bool

+ Locations []BranchLocation

+ Name string

+ TipHash string

+ TipUnix int64

+ func (lb LocalBranchRef) HasTipMismatchAcrossRemotes() bool

+ func (lb LocalBranchRef) IsLocalOnly() bool

type MultiGitStatus

+ func ScanWithProgress(config *Config, onProgress func(ScanProgress)) (MultiGitStatus, error)

+ type PorcelainEntry struct

+ OriginalPath string

+ Path string

+ Staging git.StatusCode

+ Worktree git.StatusCode

+ type PorcelainStatus struct

+ Entries []PorcelainEntry

+ func ParsePorcelainStatus(r io.Reader) (PorcelainStatus, error)

+ func (p PorcelainStatus) ToGitStatus() git.Status

type RepoStatus

+ Branches BranchStatus

+ Porcelain PorcelainStatus

+ func StatusForRepo(config *Config, dir string) (RepoStatus, bool, error)

+ type ScanProgress struct

+ CurrentPath string

+ ReposChecked int

+ ReposFound int

v0

v0.1.0

Jan 5, 2021

Changes in this version

+ func DumpConfig(config *Config) error

+ func GitStatus(d string) (git.Status, error)

+ func GoGitStatus(d string) (git.Status, error)

+ func Walk(ctx context.Context, config *Config, results chan string) error

+ type Config struct

+ FollowSymlinks bool

+ GitIgnore struct{ ... }

+ ScanDirs struct{ ... }

+ func ParseConfigFile(filename string) (*Config, error)

+ type Excluder struct

+ func NewExcluder(files, dirs []string) (Excluder, error)

+ func (e Excluder) FilterGitStatus(st git.Status) git.Status

+ func (e Excluder) IsExcluded(path string) bool

+ type MultiGitStatus map[string]RepoStatus

+ func Scan(config *Config) (MultiGitStatus, error)

+ type RepoStatus struct

+ ScanTime time.Duration