git

Documentation

Index

• func CommentChar() string
• func CurrentBranch() (string, error)
• func Dir() (string, error)
• func Edit(filePrefix, message string) (string, string, error)
• func EditFile(filePrefix, message string) (string, error)
• func Fetch(remote, commit string) error
• func GetLocalRemotes() (string, error)
• func GetLocalRemotesFromFile() (string, error)
• func InsideGitRepo() bool
• func IsRemote(remote string) (bool, error)
• func LastCommitMessage(sha string) (string, error)
• func Log(sha1, sha2 string) (string, error)
• func New(args ...string) *exec.Cmd
• func NumberCommits(sha1, sha2 string) int
• func PagerCommand() (string, []string)
• func PathWithNamespace(remote string) (string, error)
• func RemoteAdd(name, url, dir string) error
• func RemoteBranches(remote string) ([]string, error)
• func Remotes() ([]string, error)
• func RepoName() (string, error)
• func Show(commit1, commit2 string, reverse bool)
• func UpstreamBranch(branch string) (string, error)
• func WorkingDir() (string, error)

Functions

func CommentChar

func CommentChar() string

CommentChar returns active comment char and defaults to '#'

func CurrentBranch

func CurrentBranch() (string, error)

CurrentBranch returns the currently checked out branch

func Dir

func Dir() (string, error)

Dir returns the full path to the .git directory

func Edit

func Edit(filePrefix, message string) (string, string, error)

Edit opens a file in the users editor and returns the title and body.

func EditFile

func EditFile(filePrefix, message string) (string, error)

EditFile opens a file in the users editor and returns the contents. It stores a temporary file in your .git directory or /tmp if accessed outside of a git repo.

func Fetch

func Fetch(remote, commit string) error

Fetch a commit from a given remote

func GetLocalRemotes

func GetLocalRemotes() (string, error)

GetLocalRemotes returns a string of local remote names and URLs

func GetLocalRemotesFromFile

func GetLocalRemotesFromFile() (string, error)

GetLocalRemotesFromFile returns a string of local remote names and URLs based on their placement within .git/config file, which holds a different ordering compared to the alternatives presented by Remotes() and GetLocalRemotes().

func InsideGitRepo

func InsideGitRepo() bool

InsideGitRepo returns true when the current working directory is inside the working tree of a git repo

func IsRemote

func IsRemote(remote string) (bool, error)

IsRemote returns true when passed a valid remote in the git repo

func LastCommitMessage

func LastCommitMessage(sha string) (string, error)

LastCommitMessage returns the last commits message as one line

func Log

func Log(sha1, sha2 string) (string, error)

Log produces a formatted gitlog between 2 git shas

func New

func New(args ...string) *exec.Cmd

New looks up the git binary and returns a cmd which outputs to stdout

func NumberCommits

func NumberCommits(sha1, sha2 string) int

NumberCommits returns the number of commits between two commit refs

func PagerCommand

func PagerCommand() (string, []string)

PagerCommand returns the commandline and environment for the pager

func PathWithNamespace

func PathWithNamespace(remote string) (string, error)

PathWithNamespace returns the owner/repository for the current repo Such as zaquestion/lab Respects GitLab subgroups (https://docs.gitlab.com/ce/user/group/subgroups/)

func RemoteAdd

func RemoteAdd(name, url, dir string) error

RemoteAdd both adds a remote and fetches it

func RemoteBranches

func RemoteBranches(remote string) ([]string, error)

RemoteBranches get the list of branches the specified remote has

func Remotes

func Remotes() ([]string, error)

Remotes get the list of remotes available in the current repo dir

func RepoName

func RepoName() (string, error)

RepoName returns the name of the repository, such as "lab"

func Show

func Show(commit1, commit2 string, reverse bool)

Show all the commits between 2 git commits

func UpstreamBranch

func UpstreamBranch(branch string) (string, error)

UpstreamBranch returns the upstream of the specified branch

func WorkingDir

func WorkingDir() (string, error)

WorkingDir returns the full path to the root of the current git repository