Help us shape the future of Go! Take the 2026 Go Developer Survey

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
- API
  
  Reference documentation for the pkg.go.dev API
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

gitdomain

package

Go to main page

Versions in this module

v19

v19.0.0

Apr 17, 2025

Changes in this version

+ func NewAuthorOpt(name string) Option[Author]

+ func NewLocalBranchNameOption(id string) Option[LocalBranchName]

+ func NewRemote(id string) Option[Remote]

+ type Author string

+ func (self Author) String() string

+ type BranchInfo struct

+ LocalName Option[LocalBranchName]

+ LocalSHA Option[SHA]

+ RemoteName Option[RemoteBranchName]

+ RemoteSHA Option[SHA]

+ SyncStatus SyncStatus

+ func (self BranchInfo) GetLocal() (bool, LocalBranchName, SHA)

+ func (self BranchInfo) GetLocalOrRemoteName() BranchName

+ func (self BranchInfo) GetRemoteBranch() (bool, RemoteBranchName, SHA)

+ func (self BranchInfo) GetSHAs() (hasBothSHA bool, localSHA, remoteSHA SHA)

+ func (self BranchInfo) HasLocalBranch() (hasLocalBranch bool, branchName LocalBranchName, sha SHA)

+ func (self BranchInfo) HasOnlyLocalBranch() bool

+ func (self BranchInfo) HasOnlyRemoteBranch() bool

+ func (self BranchInfo) HasRemoteBranch() (hasRemoteBranch bool, remoteBranchName RemoteBranchName, remoteBranchSHA SHA)

+ func (self BranchInfo) HasTrackingBranch() bool

+ func (self BranchInfo) IsLocalOnlyBranch() (bool, LocalBranchName)

+ func (self BranchInfo) IsOmniBranch() (isOmni bool, branch LocalBranchName, sha SHA)

+ func (self BranchInfo) LocalBranchName() LocalBranchName

+ func (self BranchInfo) String() string

+ type BranchInfos []BranchInfo

+ func (self BranchInfos) BranchIsActiveInAnotherWorktree(branch LocalBranchName) bool

+ func (self BranchInfos) FindByLocalName(branchName LocalBranchName) OptionalMutable[BranchInfo]

+ func (self BranchInfos) FindByRemoteName(remoteBranch RemoteBranchName) OptionalMutable[BranchInfo]

+ func (self BranchInfos) FindLocalOrRemote(branchName LocalBranchName, remote Remote) OptionalMutable[BranchInfo]

+ func (self BranchInfos) FindMatchingRecord(other BranchInfo) OptionalMutable[BranchInfo]

+ func (self BranchInfos) HasBranch(branch LocalBranchName) bool

+ func (self BranchInfos) HasLocalBranch(branch LocalBranchName) bool

+ func (self BranchInfos) HasLocalBranches(branches LocalBranchNames) bool

+ func (self BranchInfos) HasMatchingTrackingBranchFor(localBranch LocalBranchName, devRemote Remote) bool

+ func (self BranchInfos) LocalBranches() BranchInfos

+ func (self BranchInfos) LocalBranchesWithDeletedTrackingBranches() BranchInfos

+ func (self BranchInfos) Names() LocalBranchNames

+ func (self BranchInfos) Remove(branchName LocalBranchName) BranchInfos

+ func (self BranchInfos) Select(remote Remote, names ...LocalBranchName) (result BranchInfos, nonExisting LocalBranchNames)

+ func (self BranchInfos) UpdateLocalSHA(branch LocalBranchName, sha SHA) error

+ type BranchName string

+ func NewBranchName(id string) BranchName

+ func (self BranchName) IsLocal() bool

+ func (self BranchName) LocalName() LocalBranchName

+ func (self BranchName) Location() Location

+ func (self BranchName) RemoteName() RemoteBranchName

+ func (self BranchName) String() string

+ type BranchNames []BranchName

+ func (self BranchNames) Join(sep string) string

+ func (self BranchNames) Strings() []string

+ type BranchesSnapshot struct

+ Active Option[LocalBranchName]

+ Branches BranchInfos

+ func EmptyBranchesSnapshot() BranchesSnapshot

+ type Commit struct

+ Message CommitMessage

+ SHA SHA

+ type CommitMessage string

+ func (self CommitMessage) Parts() CommitMessageParts

+ func (self CommitMessage) String() string

+ type CommitMessageParts struct

+ Subject string

+ Text string

+ type CommitMessages []CommitMessage

+ func NewCommitMessages(messages ...string) CommitMessages

+ type Commits []Commit

+ func (self Commits) ContainsSHA(sha SHA) bool

+ func (self Commits) Messages() CommitMessages

+ func (self Commits) SHAs() SHAs

+ type LocalBranchName string

+ func NewLocalBranchName(id string) LocalBranchName

+ func (self LocalBranchName) AtRemote(remote Remote) RemoteBranchName

+ func (self LocalBranchName) BranchName() BranchName

+ func (self LocalBranchName) Location() Location

+ func (self LocalBranchName) String() string

+ func (self LocalBranchName) TrackingBranch(devRemote Remote) RemoteBranchName

+ type LocalBranchNames []LocalBranchName

+ func NewLocalBranchNames(names ...string) LocalBranchNames

+ func ParseLocalBranchNames(names string) LocalBranchNames

+ func (self LocalBranchNames) AppendAllMissing(others ...LocalBranchName) LocalBranchNames

+ func (self LocalBranchNames) BranchNames() []BranchName

+ func (self LocalBranchNames) Contains(branch LocalBranchName) bool

+ func (self LocalBranchNames) Hoist(needle LocalBranchName) LocalBranchNames

+ func (self LocalBranchNames) Join(sep string) string

+ func (self LocalBranchNames) Remove(toRemove ...LocalBranchName) LocalBranchNames

+ func (self LocalBranchNames) RemoveWorktreeMarkers() LocalBranchNames

+ func (self LocalBranchNames) Sort()

+ func (self LocalBranchNames) String() string

+ func (self LocalBranchNames) Strings() []string

+ type Location string

+ func NewLocation(id string) Location

+ func (self Location) IsRemoteBranchName() bool

+ func (self Location) String() string

+ type ProposalBody string

+ func (self ProposalBody) String() string

+ type ProposalBodyFile string

+ func (self ProposalBodyFile) ShouldReadStdin() bool

+ func (self ProposalBodyFile) String() string

+ type ProposalTitle string

+ func (self ProposalTitle) String() string

+ type Querier interface

+ Query func(executable string, args ...string) (string, error)

+ QueryTrim func(executable string, args ...string) (string, error)

+ QueryWithEnv func(env []string, executable string, args ...string) (string, error)

+ type Remote string

+ const RemoteOrigin

+ const RemoteUpstream

+ func (self Remote) String() string

+ type RemoteBranchName string

+ func NewRemoteBranchName(id string) RemoteBranchName

+ func (self RemoteBranchName) BranchName() BranchName

+ func (self RemoteBranchName) LocalBranchName() LocalBranchName

+ func (self RemoteBranchName) Parts() (Remote, LocalBranchName)

+ func (self RemoteBranchName) Remote() Remote

+ func (self RemoteBranchName) String() string

+ type RemoteBranchNames []RemoteBranchName

+ func (self RemoteBranchNames) Sort()

+ func (self RemoteBranchNames) Strings() []string

+ type Remotes []Remote

+ func NewRemotes(remotes ...string) Remotes

+ func (self Remotes) HasRemote(remote Remote) bool

+ func (self Remotes) HasUpstream() bool

+ type RepoRootDir string

+ func NewRepoRootDir(dir string) RepoRootDir

+ func (self RepoRootDir) String() string

+ type RepoStatus struct

+ Conflicts bool

+ OpenChanges bool

+ RebaseInProgress bool

+ UntrackedChanges bool

+ type Runner interface

+ Run func(executable string, args ...string) error

+ type RunnerQuerier interface

+ type SHA string

+ func NewSHA(id string) SHA

+ func NewSHAErr(id string) (SHA, error)

+ func (self SHA) Location() Location

+ func (self SHA) String() string

+ func (self SHA) TruncateTo(newLength int) SHA

+ type SHAs []SHA

+ func NewSHAs(ids ...string) SHAs

+ func (self SHAs) First() SHA

+ func (self SHAs) Join(sep string) string

+ func (self SHAs) Last() SHA

+ func (self SHAs) Strings() []string

+ type StashSize int

+ type SyncStatus string

+ const SyncStatusAhead

+ const SyncStatusBehind

+ const SyncStatusDeletedAtRemote

+ const SyncStatusLocalOnly

+ const SyncStatusNotInSync

+ const SyncStatusOtherWorktree

+ const SyncStatusRemoteOnly

+ const SyncStatusUpToDate

+ func (self SyncStatus) String() string

Other modules containing this package

github.com/git-town/git-town/v15

github.com/git-town/git-town/v16

github.com/git-town/git-town/v17

github.com/git-town/git-town/v18

github.com/git-town/git-town/v20

github.com/git-town/git-town/v21

github.com/git-town/git-town/v22

github.com/git-town/git-town/v23

github.com/git-town/git-town/v24