gitcli

package

v2.0.0 Latest Latest Go to latest Published: Mar 8, 2026 License: MPL-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/thejokersthief/banshee

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type ExecGit
- func NewExecGit(showOutput bool, log *logrus.Entry) *ExecGit
type Git
type GitError
- func (e *GitError) Error() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrBranchAlreadyExists = errors.New("git: branch already exists")
	ErrAlreadyUpToDate     = errors.New("git: already up to date")
	ErrReferenceNotFound   = errors.New("git: reference not found")
	ErrRemoteRefNotFound   = errors.New("git: couldn't find remote ref")
)

Functions ¶

This section is empty.

Types ¶

type ExecGit ¶

type ExecGit struct {
	// contains filtered or unexported fields
}

ExecGit runs git commands via the system git binary.

func NewExecGit ¶

func NewExecGit(showOutput bool, log *logrus.Entry) *ExecGit

func (*ExecGit) AddAll ¶

func (g *ExecGit) AddAll(dir string) error

AddAll stages all changes.

func (*ExecGit) Checkout ¶

func (g *ExecGit) Checkout(dir, branch string, create bool) error

Checkout switches to branch. When create=true it tries -b first, then falls back to a plain checkout if the branch already exists.

func (*ExecGit) Clone ¶

func (g *ExecGit) Clone(tokenURL, dir, branch string, depth int) error

Clone performs a single-branch clone, optionally shallow.

func (*ExecGit) Commit ¶

func (g *ExecGit) Commit(dir, message, authorName, authorEmail string) error

Commit creates a commit with the given message and author/committer identity. -c user.name/email sets the committer; --author sets the author explicitly.

func (*ExecGit) Fetch ¶

func (g *ExecGit) Fetch(dir, tokenURL, branch string) error

Fetch fetches branch from the given URL. ErrRemoteRefNotFound, ErrAlreadyUpToDate, "refusing to fetch into current branch", and "shallow update not allowed" are swallowed.

func (*ExecGit) IsClean ¶

func (g *ExecGit) IsClean(dir string) (bool, error)

IsClean returns true when the working tree has no changes.

func (*ExecGit) Pull ¶

func (g *ExecGit) Pull(dir, tokenURL, branch string) error

Pull hard-resets HEAD then fast-forward pulls from the given URL. ErrAlreadyUpToDate is swallowed; all other errors (including ErrReferenceNotFound when the remote branch does not exist) are surfaced to the caller.

func (*ExecGit) Push ¶

func (g *ExecGit) Push(dir, tokenURL, branch string) error

Push pushes the current HEAD to branch on the remote using an unambiguous refs/heads/ refspec. ErrAlreadyUpToDate is swallowed.

type Git ¶

type Git interface {
	Clone(tokenURL, dir, branch string, depth int) error
	Checkout(dir, branch string, create bool) error
	Fetch(dir, tokenURL, branch string) error
	Pull(dir, tokenURL, branch string) error
	Push(dir, tokenURL, branch string) error
	IsClean(dir string) (bool, error)
	AddAll(dir string) error
	Commit(dir, message, authorName, authorEmail string) error
}

type GitError ¶

type GitError struct {
	Stderr string
}

GitError holds the raw stderr output when git exits non-zero and no sentinel applies.

func (*GitError) Error ¶

func (e *GitError) Error() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL