type AddOptions struct {// All equivalent to `git add -A`, update the index not only where the// working tree has a file matching `Path` but also where the index already// has an entry. This adds, modifies, and removes index entries to match the// working tree.  If no `Path` nor `Glob` is given when `All` option is// used, all files in the entire working tree are updated.Allbool// Path is the exact filepath to the file or directory to be added.Pathstring// Glob adds all paths, matching pattern, to the index. If pattern matches a// directory path, all directory contents are added to the index recursively.Globstring// SkipStatus adds the path with no status check. This option is relevant only// when the `Path` option is specified and does not apply when the `All` option is used.// Notice that when passing an ignored path it will be added anyway.// When true it can speed up adding files to the worktree in very large repositories.SkipStatusbool}

func (*AddOptions)Validate¶added inv5.2.0

func (o *AddOptions) Validate(r *Repository)error

Validate validates the fields and sets the default values.

type BlameResult struct {// Path is the path of the File that we're blaming.Pathstring// Rev (Revision) is the hash of the specified Commit used to generate this result.Revplumbing.Hash// Lines contains every line with its authorship.Lines []*Line}

funcBlame¶

func Blame(c *object.Commit, pathstring) (*BlameResult,error)

Blame returns a BlameResult with the information about the last author ofeach line from file `path` at commit `c`.

func (BlameResult)String¶added inv5.8.0

func (bBlameResult) String()string

String prints the results of a Blame using git-blame's style.

type CheckoutOptions struct {// Hash is the hash of a commit or tag to be checked out. If used, HEAD// will be in detached mode. If Create is not used, Branch and Hash are// mutually exclusive.Hashplumbing.Hash// Branch to be checked out, if Branch and Hash are empty is set to `master`.Branchplumbing.ReferenceName// Create a new branch named Branch and start it at Hash.Createbool// Force, if true when switching branches, proceed even if the index or the// working tree differs from HEAD. This is used to throw away local changesForcebool// Keep, if true when switching branches, local changes (the index or the// working tree changes) will be kept so that they can be committed to the// target branch. Force and Keep are mutually exclusive, should not be both// set to true.Keepbool// SparseCheckoutDirectoriesSparseCheckoutDirectories []string}

func (*CheckoutOptions)Validate¶

func (o *CheckoutOptions) Validate()error

Validate validates the fields and sets the default values.

type CleanOptions struct {Dirbool}

type CloneOptions struct {// The (possibly remote) repository URL to clone from.URLstring// Auth credentials, if required, to use with the remote repository.Authtransport.AuthMethod// Name of the remote to be added, by default `origin`.RemoteNamestring// Remote branch to clone.ReferenceNameplumbing.ReferenceName// Fetch only ReferenceName if true.SingleBranchbool// Mirror clones the repository as a mirror.//// Compared to a bare clone, mirror not only maps local branches of the// source to local branches of the target, it maps all refs (including// remote-tracking branches, notes etc.) and sets up a refspec configuration// such that all these refs are overwritten by a git remote update in the// target repository.Mirrorbool// No checkout of HEAD after clone if true.NoCheckoutbool// Limit fetching to the specified number of commits.Depthint// RecurseSubmodules after the clone is created, initialize all submodules// within, using their default settings. This option is ignored if the// cloned repository does not have a worktree.RecurseSubmodulesSubmoduleRescursivity// ShallowSubmodules limit cloning submodules to the 1 level of depth.// It matches the git command --shallow-submodules.ShallowSubmodulesbool// Progress is where the human readable information sent by the server is// stored, if nil nothing is stored and the capability (if supported)// no-progress, is sent to the server to avoid send this information.Progresssideband.Progress// Tags describe how the tags will be fetched from the remote repository,// by default is AllTags.TagsTagMode// InsecureSkipTLS skips SSL verification if protocol is HTTPS.InsecureSkipTLSbool// ClientCert is the client certificate to use for mutual TLS authentication// over the HTTPS protocol.ClientCert []byte// ClientKey is the client key to use for mutual TLS authentication over// the HTTPS protocol.ClientKey []byte// CABundle specifies an additional CA bundle to use together with the// system cert pool.CABundle []byte// ProxyOptions provides info required for connecting to a proxy.ProxyOptionstransport.ProxyOptions// When the repository to clone is on the local machine, instead of// using hard links, automatically setup .git/objects/info/alternates// to share the objects with the source repository.// The resulting repository starts out without any object of its own.// NOTE: this is a possibly dangerous operation; do not use it unless// you understand what it does.//// [Reference]:https://git-scm.com/docs/git-clone#Documentation/git-clone.txt---sharedSharedbool}

func (*CloneOptions)Validate¶

func (o *CloneOptions) Validate()error

Validate validates the fields and sets the default values.

type CommitOptions struct {// All automatically stage files that have been modified and deleted, but// new files you have not told Git about are not affected.Allbool// AllowEmptyCommits enable empty commits to be created. An empty commit// is when no changes to the tree were made, but a new commit message is// provided. The default behavior is false, which results in ErrEmptyCommit.AllowEmptyCommitsbool// Author is the author's signature of the commit. If Author is empty the// Name and Email is read from the config, and time.Now it's used as When.Author *object.Signature// Committer is the committer's signature of the commit. If Committer is// nil the Author signature is used.Committer *object.Signature// Parents are the parents commits for the new commit, by default when// len(Parents) is zero, the hash of HEAD reference is used.Parents []plumbing.Hash// SignKey denotes a key to sign the commit with. A nil value here means the// commit will not be signed. The private key must be present and already// decrypted.SignKey *openpgp.Entity// Signer denotes a cryptographic signer to sign the commit with.// A nil value here means the commit will not be signed.// Takes precedence over SignKey.SignerSigner// Amend will create a new commit object and replace the commit that HEAD currently// points to. Cannot be used with All nor Parents.Amendbool}

func (*CommitOptions)Validate¶

func (o *CommitOptions) Validate(r *Repository)error

Validate validates the fields and sets the default values.

type CreateTagOptions struct {// Tagger defines the signature of the tag creator. If Tagger is empty the// Name and Email is read from the config, and time.Now it's used as When.Tagger *object.Signature// Message defines the annotation of the tag. It is canonicalized during// validation into the format expected by git - no leading whitespace and// ending in a newline.Messagestring// SignKey denotes a key to sign the tag with. A nil value here means the tag// will not be signed. The private key must be present and already decrypted.SignKey *openpgp.Entity}

func (*CreateTagOptions)Validate¶

func (o *CreateTagOptions) Validate(r *Repository, hashplumbing.Hash)error

Validate validates the fields and sets the default values.

type FetchOptions struct {// Name of the remote to fetch from. Defaults to origin.RemoteNamestring// RemoteURL overrides the remote repo address with a custom URLRemoteURLstringRefSpecs  []config.RefSpec// Depth limit fetching to the specified number of commits from the tip of// each remote branch history.Depthint// Auth credentials, if required, to use with the remote repository.Authtransport.AuthMethod// Progress is where the human readable information sent by the server is// stored, if nil nothing is stored and the capability (if supported)// no-progress, is sent to the server to avoid send this information.Progresssideband.Progress// Tags describe how the tags will be fetched from the remote repository,// by default is TagFollowing.TagsTagMode// Force allows the fetch to update a local branch even when the remote// branch does not descend from it.Forcebool// InsecureSkipTLS skips SSL verification if protocol is HTTPS.InsecureSkipTLSbool// ClientCert is the client certificate to use for mutual TLS authentication// over the HTTPS protocol.ClientCert []byte// ClientKey is the client key to use for mutual TLS authentication over// the HTTPS protocol.ClientKey []byte// CABundle specifies an additional CA bundle to use together with the// system cert pool.CABundle []byte// ProxyOptions provides info required for connecting to a proxy.ProxyOptionstransport.ProxyOptions// Prune specify that local refs that match given RefSpecs and that do// not exist remotely will be removed.Prunebool}

func (*FetchOptions)Validate¶

func (o *FetchOptions) Validate()error

Validate validates the fields and sets the default values.

type FileStatus struct {// Staging is the status of a file in the staging areaStagingStatusCode// Worktree is the status of a file in the worktreeWorktreeStatusCode// Extra contains extra information, such as the previous name in a renameExtrastring}

type ForceWithLease struct {// RefName, when set will protect the ref by ensuring it matches the// hash in the ref advertisement.RefNameplumbing.ReferenceName// Hash is the expected object id of RefName. The push will be rejected unless this// matches the corresponding object id of RefName in the refs advertisement.Hashplumbing.Hash}

type GrepOptions struct {// Patterns are compiled Regexp objects to be matched.Patterns []*regexp.Regexp// InvertMatch selects non-matching lines.InvertMatchbool// CommitHash is the hash of the commit from which worktree should be derived.CommitHashplumbing.Hash// ReferenceName is the branch or tag name from which worktree should be derived.ReferenceNameplumbing.ReferenceName// PathSpecs are compiled Regexp objects of pathspec to use in the matching.PathSpecs []*regexp.Regexp}

func (*GrepOptions)Validate¶

func (o *GrepOptions) Validate(w *Worktree)error

Validate validates the fields and sets the default values.

TODO: deprecate in favor of Validate(r *Repository) in v6.

type GrepResult struct {// FileName is the name of file which contains match.FileNamestring// LineNumber is the line number of a file at which a match was found.LineNumberint// Content is the content of the file at the matching line.Contentstring// TreeName is the name of the tree (reference name/commit hash) at// which the match was performed.TreeNamestring}

func (GrepResult)String¶

func (grGrepResult) String()string

type InitOptions struct {// The default branch (e.g. "refs/heads/master")DefaultBranchplumbing.ReferenceName}

type Line struct {// Author is the email address of the last author that modified the line.Authorstring// AuthorName is the name of the last author that modified the line.AuthorNamestring// Text is the original text of the line.Textstring// Date is when the original text of the line was introducedDatetime.Time// Hash is the commit hash that introduced the original lineHashplumbing.Hash}

type ListOptions struct {// Auth credentials, if required, to use with the remote repository.Authtransport.AuthMethod// InsecureSkipTLS skips SSL verification if protocol is HTTPS.InsecureSkipTLSbool// ClientCert is the client certificate to use for mutual TLS authentication// over the HTTPS protocol.ClientCert []byte// ClientKey is the client key to use for mutual TLS authentication over// the HTTPS protocol.ClientKey []byte// CABundle specifies an additional CA bundle to use together with the// system cert pool.CABundle []byte// PeelingOption defines how peeled objects are handled during a// remote list.PeelingOptionPeelingOption// ProxyOptions provides info required for connecting to a proxy.ProxyOptionstransport.ProxyOptions// Timeout specifies the timeout in seconds for list operationsTimeoutint}

type LogOptions struct {// When the From option is set the log will only contain commits// reachable from it. If this option is not set, HEAD will be used as// the default From.Fromplumbing.Hash// The default traversal algorithm is Depth-first search// set Order=LogOrderCommitterTime for ordering by committer time (more compatible with `git log`)// set Order=LogOrderBSF for Breadth-first searchOrderLogOrder// Show only those commits in which the specified file was inserted/updated.// It is equivalent to running `git log -- <file-name>`.// this field is kept for compatibility, it can be replaced with PathFilterFileName *string// Filter commits based on the path of files that are updated// takes file path as argument and should return true if the file is desired// It can be used to implement `git log -- <path>`// either <path> is a file path, or directory path, or a regexp of file/directory pathPathFilter func(string)bool// Pretend as if all the refs in refs/, along with HEAD, are listed on the command line as <commit>.// It is equivalent to running `git log --all`.// If set on true, the From option will be ignored.Allbool// Show commits more recent than a specific date.// It is equivalent to running `git log --since <date>` or `git log --after <date>`.Since *time.Time// Show commits older than a specific date.// It is equivalent to running `git log --until <date>` or `git log --before <date>`.Until *time.Time}

type LogOrderint8

type MergeOptions struct {// Strategy defines the merge strategy to be used.StrategyMergeStrategy}

type MergeStrategyint8

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

func (NoMatchingRefSpecError)Error¶added inv5.2.0

func (eNoMatchingRefSpecError) Error()string

func (NoMatchingRefSpecError)Is¶added inv5.2.0

func (eNoMatchingRefSpecError) Is(targeterror)bool

type PeelingOptionuint8

type PlainInitOptions struct {InitOptions// Determines if the repository will have a worktree (non-bare) or not (bare).BareboolObjectFormatformatcfg.ObjectFormat}

func (*PlainInitOptions)Validate¶added inv5.7.0

func (o *PlainInitOptions) Validate()error

Validate validates the fields and sets the default values.

type PlainOpenOptions struct {// DetectDotGit defines whether parent directories should be// walked until a .git directory or file is found.DetectDotGitbool// Enable .git/commondir support (seehttps://git-scm.com/docs/gitrepository-layout#Documentation/gitrepository-layout.txt).// NOTE: This option will only work with the filesystem storage.EnableDotGitCommonDirbool}

func (*PlainOpenOptions)Validate¶

func (o *PlainOpenOptions) Validate()error

Validate validates the fields and sets the default values.

type PruneHandler func(unreferencedObjectHashplumbing.Hash)error

type PruneOptions struct {// OnlyObjectsOlderThan if set to non-zero value// selects only objects older than the time provided.OnlyObjectsOlderThantime.Time// Handler is called on matching objectsHandlerPruneHandler}

type PullOptions struct {// Name of the remote to be pulled. If empty, uses the default.RemoteNamestring// RemoteURL overrides the remote repo address with a custom URLRemoteURLstring// Remote branch to clone. If empty, uses HEAD.ReferenceNameplumbing.ReferenceName// Fetch only ReferenceName if true.SingleBranchbool// Limit fetching to the specified number of commits.Depthint// Auth credentials, if required, to use with the remote repository.Authtransport.AuthMethod// RecurseSubmodules controls if new commits of all populated submodules// should be fetched too.RecurseSubmodulesSubmoduleRescursivity// Progress is where the human readable information sent by the server is// stored, if nil nothing is stored and the capability (if supported)// no-progress, is sent to the server to avoid send this information.Progresssideband.Progress// Force allows the pull to update a local branch even when the remote// branch does not descend from it.Forcebool// InsecureSkipTLS skips SSL verification if protocol is HTTPS.InsecureSkipTLSbool// ClientCert is the client certificate to use for mutual TLS authentication// over the HTTPS protocol.ClientCert []byte// ClientKey is the client key to use for mutual TLS authentication over// the HTTPS protocol.ClientKey []byte// CABundle specifies an additional CA bundle to use together with the// system cert pool.CABundle []byte// ProxyOptions provides info required for connecting to a proxy.ProxyOptionstransport.ProxyOptions}

func (*PullOptions)Validate¶

func (o *PullOptions) Validate()error

Validate validates the fields and sets the default values.

type PushOptions struct {// RemoteName is the name of the remote to be pushed to.RemoteNamestring// RemoteURL overrides the remote repo address with a custom URLRemoteURLstring// RefSpecs specify what destination ref to update with what source object.//// The format of a <refspec> parameter is an optional plus +, followed by//  the source object <src>, followed by a colon :, followed by the destination ref <dst>.// The <src> is often the name of the branch you would want to push, but it can be a SHA-1.// The <dst> tells which ref on the remote side is updated with this push.//// A refspec with empty src can be used to delete a reference.RefSpecs []config.RefSpec// Auth credentials, if required, to use with the remote repository.Authtransport.AuthMethod// Progress is where the human readable information sent by the server is// stored, if nil nothing is stored.Progresssideband.Progress// Prune specify that remote refs that match given RefSpecs and that do// not exist locally will be removed.Prunebool// Force allows the push to update a remote branch even when the local// branch does not descend from it.Forcebool// InsecureSkipTLS skips SSL verification if protocol is HTTPS.InsecureSkipTLSbool// ClientCert is the client certificate to use for mutual TLS authentication// over the HTTPS protocol.ClientCert []byte// ClientKey is the client key to use for mutual TLS authentication over// the HTTPS protocol.ClientKey []byte// CABundle specifies an additional CA bundle to use together with the// system cert pool.CABundle []byte// RequireRemoteRefs only allows a remote ref to be updated if its current// value is the one specified here.RequireRemoteRefs []config.RefSpec// FollowTags will send any annotated tags with a commit target reachable from// the refs already being pushedFollowTagsbool// ForceWithLease allows a force push as long as the remote ref adheres to a "lease"ForceWithLease *ForceWithLease// PushOptions sets options to be transferred to the server during push.Options map[string]string// Atomic sets option to be an atomic pushAtomicbool// ProxyOptions provides info required for connecting to a proxy.ProxyOptionstransport.ProxyOptions}

func (*PushOptions)Validate¶

func (o *PushOptions) Validate()error

Validate validates the fields and sets the default values.

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

funcNewRemote¶

func NewRemote(sstorage.Storer, c *config.RemoteConfig) *Remote

NewRemote creates a new Remote.The intended purpose is to use the Remote for tasks such as listing remote references (like using git ls-remote).Otherwise Remotes should be created via the use of a Repository.

func (*Remote)Config¶

func (r *Remote) Config() *config.RemoteConfig

Config returns the RemoteConfig object used to instantiate this Remote.

func (*Remote)Fetch¶

func (r *Remote) Fetch(o *FetchOptions)error

Fetch fetches references along with the objects necessary to complete theirhistories.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there areno changes to be fetched, or an error.

func (*Remote)FetchContext¶

func (r *Remote) FetchContext(ctxcontext.Context, o *FetchOptions)error

FetchContext fetches references along with the objects necessary to completetheir histories.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there areno changes to be fetched, or an error.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

func (*Remote)List¶

func (r *Remote) List(o *ListOptions) (rfs []*plumbing.Reference, errerror)

func (*Remote)ListContext¶added inv5.4.0

func (r *Remote) ListContext(ctxcontext.Context, o *ListOptions) (rfs []*plumbing.Reference, errerror)

List the references on the remote repository.The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects to thetransport operations.

func (*Remote)Push¶

func (r *Remote) Push(o *PushOptions)error

Push performs a push to the remote. Returns NoErrAlreadyUpToDate if theremote was already up-to-date.

func (*Remote)PushContext¶

func (r *Remote) PushContext(ctxcontext.Context, o *PushOptions) (errerror)

PushContext performs a push to the remote. Returns NoErrAlreadyUpToDate ifthe remote was already up-to-date.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

func (*Remote)String¶

func (r *Remote) String()string

type RepackConfig struct {// UseRefDeltas configures whether packfile encoder will use reference deltas.// By default OFSDeltaObject is used.UseRefDeltasbool// OnlyDeletePacksOlderThan if set to non-zero value// selects only objects older than the time provided.OnlyDeletePacksOlderThantime.Time}

type Repository struct {Storerstorage.Storer// contains filtered or unexported fields}

funcClone¶

func Clone(sstorage.Storer, worktreebilly.Filesystem, o *CloneOptions) (*Repository,error)

Clone a repository into the given Storer and worktree Filesystem with thegiven options, if worktree is nil a bare repository is created. If the givenstorer is not empty ErrRepositoryAlreadyExists is returned.

// Filesystem abstraction based on memoryfs := memfs.New()// Git objects storer based on memorystorer := memory.NewStorage()// Clones the repository into the worktree (fs) and stores all the .git// content into the storer_, err := git.Clone(storer, fs, &git.CloneOptions{URL: "https://github.com/git-fixtures/basic.git",})if err != nil {log.Fatal(err)}// Prints the content of the CHANGELOG file from the cloned repositorychangelog, err := fs.Open("CHANGELOG")if err != nil {log.Fatal(err)}io.Copy(os.Stdout, changelog)

Output:Initial changelog

funcCloneContext¶

func CloneContext(ctxcontext.Context, sstorage.Storer, worktreebilly.Filesystem, o *CloneOptions,) (*Repository,error)

CloneContext a repository into the given Storer and worktree Filesystem withthe given options, if worktree is nil a bare repository is created. If thegiven storer is not empty ErrRepositoryAlreadyExists is returned.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

funcInit¶

func Init(sstorage.Storer, worktreebilly.Filesystem) (*Repository,error)

Init creates an empty git repository, based on the given Storer and worktree.The worktree Filesystem is optional, if nil a bare repository is created. Ifthe given storer is not empty ErrRepositoryAlreadyExists is returned

funcInitWithOptions¶added inv5.7.0

func InitWithOptions(sstorage.Storer, worktreebilly.Filesystem, optionsInitOptions) (*Repository,error)

funcOpen¶

func Open(sstorage.Storer, worktreebilly.Filesystem) (*Repository,error)

Open opens a git repository using the given Storer and worktree filesystem,if the given storer is complete empty ErrRepositoryNotExists is returned.The worktree can be nil when the repository being opened is bare, if therepository is a normal one (not bare) and worktree is nil the errErrWorktreeNotProvided is returned

funcPlainClone¶

func PlainClone(pathstring, isBarebool, o *CloneOptions) (*Repository,error)

PlainClone a repository into the path with the given options, isBare definesif the new repository will be bare or normal. If the path is not emptyErrRepositoryAlreadyExists is returned.

TODO(mcuadros): move isBare to CloneOptions in v5

// Tempdir to clone the repositorydir, err := os.MkdirTemp("", "clone-example")if err != nil {log.Fatal(err)}defer os.RemoveAll(dir) // clean up// Clones the repository into the given dir, just as a normal git clone does_, err = git.PlainClone(dir, false, &git.CloneOptions{URL: "https://github.com/git-fixtures/basic.git",})if err != nil {log.Fatal(err)}// Prints the content of the CHANGELOG file from the cloned repositorychangelog, err := os.Open(filepath.Join(dir, "CHANGELOG"))if err != nil {log.Fatal(err)}io.Copy(os.Stdout, changelog)

Output:Initial changelog

// Tempdir to clone the repositorydir, err := os.MkdirTemp("", "clone-example")if err != nil {log.Fatal(err)}defer os.RemoveAll(dir) // clean up// Clones the repository into the given dir, just as a normal git clone does_, err = git.PlainClone(dir, false, &git.CloneOptions{URL: "https://github.com/git-fixtures/basic.git",Auth: &http.BasicAuth{Username: "abc123", // anything except an empty stringPassword: "github_access_token",},})if err != nil {log.Fatal(err)}

// Tempdir to clone the repositorydir, err := os.MkdirTemp("", "clone-example")if err != nil {log.Fatal(err)}defer os.RemoveAll(dir) // clean up// Clones the repository into the given dir, just as a normal git clone does_, err = git.PlainClone(dir, false, &git.CloneOptions{URL: "https://github.com/git-fixtures/basic.git",Auth: &http.BasicAuth{Username: "username",Password: "password",},})if err != nil {log.Fatal(err)}

funcPlainCloneContext¶

func PlainCloneContext(ctxcontext.Context, pathstring, isBarebool, o *CloneOptions) (*Repository,error)

PlainCloneContext a repository into the path with the given options, isBaredefines if the new repository will be bare or normal. If the path is not emptyErrRepositoryAlreadyExists is returned.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

TODO(mcuadros): move isBare to CloneOptions in v5TODO(smola): refuse upfront to clone on a non-empty directory in v5, see #1027

funcPlainInit¶

func PlainInit(pathstring, isBarebool) (*Repository,error)

PlainInit create an empty git repository at the given path. isBare definesif the repository will have worktree (non-bare) or not (bare), if the pathis not empty ErrRepositoryAlreadyExists is returned.

funcPlainInitWithOptions¶added inv5.7.0

func PlainInitWithOptions(pathstring, opts *PlainInitOptions) (*Repository,error)

funcPlainOpen¶

func PlainOpen(pathstring) (*Repository,error)

PlainOpen opens a git repository from the given path. It detects if therepository is bare or a normal one. If the path doesn't contain a validrepository ErrRepositoryNotExists is returned

funcPlainOpenWithOptions¶

func PlainOpenWithOptions(pathstring, o *PlainOpenOptions) (*Repository,error)

PlainOpenWithOptions opens a git repository from the given path with specificoptions. See PlainOpen for more info.

func (*Repository)BlobObject¶

func (r *Repository) BlobObject(hplumbing.Hash) (*object.Blob,error)

BlobObject returns a Blob with the given hash. If not foundplumbing.ErrObjectNotFound is returned.

func (*Repository)BlobObjects¶

func (r *Repository) BlobObjects() (*object.BlobIter,error)

BlobObjects returns an unsorted BlobIter with all the blobs in the repository.

func (*Repository)Branch¶

func (r *Repository) Branch(namestring) (*config.Branch,error)

Branch return a Branch if exists

func (*Repository)Branches¶

func (r *Repository) Branches() (storer.ReferenceIter,error)

Branches returns all the References that are Branches.

r, _ := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{URL: "https://github.com/git-fixtures/basic.git",})branches, _ := r.Branches()branches.ForEach(func(branch *plumbing.Reference) error {fmt.Println(branch.Hash().String(), branch.Name())return nil})// Example Output:// 6ecf0ef2c2dffb796033e5a02219af86ec6584e5 refs/heads/master

func (*Repository)CommitObject¶

func (r *Repository) CommitObject(hplumbing.Hash) (*object.Commit,error)

CommitObject return a Commit with the given hash. If not foundplumbing.ErrObjectNotFound is returned.

func (*Repository)CommitObjects¶

func (r *Repository) CommitObjects() (object.CommitIter,error)

CommitObjects returns an unsorted CommitIter with all the commits in the repository.

func (*Repository)Config¶

func (r *Repository) Config() (*config.Config,error)

Config return the repository config. In a filesystem backed repository thismeans read the `.git/config`.

func (*Repository)ConfigScoped¶added inv5.1.0

func (r *Repository) ConfigScoped(scopeconfig.Scope) (*config.Config,error)

ConfigScoped returns the repository config, merged with requested scope andlower. For example if, config.GlobalScope is given the local and global configare returned merged in one config value.

func (*Repository)CreateBranch¶

func (r *Repository) CreateBranch(c *config.Branch)error

CreateBranch creates a new Branch

func (*Repository)CreateRemote¶

func (r *Repository) CreateRemote(c *config.RemoteConfig) (*Remote,error)

CreateRemote creates a new remote

r, _ := git.Init(memory.NewStorage(), nil)// Add a new remote, with the default fetch refspec_, err := r.CreateRemote(&config.RemoteConfig{Name: "example",URLs: []string{"https://github.com/git-fixtures/basic.git"},})if err != nil {log.Fatal(err)}list, err := r.Remotes()if err != nil {log.Fatal(err)}for _, r := range list {fmt.Println(r)}// Example Output:// example https://github.com/git-fixtures/basic.git (fetch)// example https://github.com/git-fixtures/basic.git (push)

func (*Repository)CreateRemoteAnonymous¶

func (r *Repository) CreateRemoteAnonymous(c *config.RemoteConfig) (*Remote,error)

CreateRemoteAnonymous creates a new anonymous remote. c.Name must be "anonymous".It's used like 'git fetch git@github.com:src-d/go-git.git master:master'.

func (*Repository)CreateTag¶

func (r *Repository) CreateTag(namestring, hashplumbing.Hash, opts *CreateTagOptions) (*plumbing.Reference,error)

CreateTag creates a tag. If opts is included, the tag is an annotated tag,otherwise a lightweight tag is created.

func (*Repository)DeleteBranch¶

func (r *Repository) DeleteBranch(namestring)error

DeleteBranch delete a Branch from the repository and delete the config

func (*Repository)DeleteObject¶

func (r *Repository) DeleteObject(hashplumbing.Hash)error

DeleteObject deletes an object from a repository.The type conveniently matches PruneHandler.

func (*Repository)DeleteRemote¶

func (r *Repository) DeleteRemote(namestring)error

DeleteRemote delete a remote from the repository and delete the config

func (*Repository)DeleteTag¶

func (r *Repository) DeleteTag(namestring)error

DeleteTag deletes a tag from the repository.

func (*Repository)Fetch¶

func (r *Repository) Fetch(o *FetchOptions)error

Fetch fetches references along with the objects necessary to completetheir histories, from the remote named as FetchOptions.RemoteName.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there areno changes to be fetched, or an error.

func (*Repository)FetchContext¶

func (r *Repository) FetchContext(ctxcontext.Context, o *FetchOptions)error

FetchContext fetches references along with the objects necessary to completetheir histories, from the remote named as FetchOptions.RemoteName.

Returns nil if the operation is successful, NoErrAlreadyUpToDate if there areno changes to be fetched, or an error.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

func (*Repository)Grep¶added inv5.7.0

func (r *Repository) Grep(opts *GrepOptions) ([]GrepResult,error)

Grep performs grep on a repository.

func (*Repository)Head¶

func (r *Repository) Head() (*plumbing.Reference,error)

Head returns the reference where HEAD is pointing to.

func (*Repository)Log¶

func (r *Repository) Log(o *LogOptions) (object.CommitIter,error)

Log returns the commit history from the given LogOptions.

func (*Repository)Merge¶added inv5.12.0

func (r *Repository) Merge(refplumbing.Reference, optsMergeOptions)error

Merge merges the reference branch into the current branch.

If the merge is not possible (or supported) returns an error without changingthe HEAD for the current branch. Possible errors include:

• The merge strategy is not supported.
• The specific strategy cannot be used (e.g. using FastForwardMerge when one is not possible).

func (*Repository)Notes¶

func (r *Repository) Notes() (storer.ReferenceIter,error)

Notes returns all the References that are notes. For more information:https://git-scm.com/docs/git-notes

func (*Repository)Object¶

func (r *Repository) Object(tplumbing.ObjectType, hplumbing.Hash) (object.Object,error)

Object returns an Object with the given hash. If not foundplumbing.ErrObjectNotFound is returned.

func (*Repository)Objects¶

func (r *Repository) Objects() (*object.ObjectIter,error)

Objects returns an unsorted ObjectIter with all the objects in the repository.

func (*Repository)Prune¶

func (r *Repository) Prune(optPruneOptions)error

func (*Repository)Push¶

func (r *Repository) Push(o *PushOptions)error

Push performs a push to the remote. Returns NoErrAlreadyUpToDate ifthe remote was already up-to-date, from the remote named asFetchOptions.RemoteName.

func (*Repository)PushContext¶

func (r *Repository) PushContext(ctxcontext.Context, o *PushOptions)error

PushContext performs a push to the remote. Returns NoErrAlreadyUpToDate ifthe remote was already up-to-date, from the remote named asFetchOptions.RemoteName.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

func (*Repository)Reference¶

func (r *Repository) Reference(nameplumbing.ReferenceName, resolvedbool) (*plumbing.Reference,error)

Reference returns the reference for a given reference name. If resolved istrue, any symbolic reference will be resolved.

func (*Repository)References¶

func (r *Repository) References() (storer.ReferenceIter,error)

References returns an unsorted ReferenceIter for all references.

r, _ := git.Clone(memory.NewStorage(), nil, &git.CloneOptions{URL: "https://github.com/git-fixtures/basic.git",})// simulating a git show-refrefs, _ := r.References()refs.ForEach(func(ref *plumbing.Reference) error {if ref.Type() == plumbing.HashReference {fmt.Println(ref)}return nil})// Example Output:// 6ecf0ef2c2dffb796033e5a02219af86ec6584e5 refs/remotes/origin/master// e8d3ffab552895c19b9fcf7aa264d277cde33881 refs/remotes/origin/branch// 6ecf0ef2c2dffb796033e5a02219af86ec6584e5 refs/heads/master

func (*Repository)Remote¶

func (r *Repository) Remote(namestring) (*Remote,error)

Remote return a remote if exists

func (*Repository)Remotes¶

func (r *Repository) Remotes() ([]*Remote,error)

Remotes returns a list with all the remotes

func (*Repository)RepackObjects¶

func (r *Repository) RepackObjects(cfg *RepackConfig) (errerror)

func (*Repository)ResolveRevision¶

func (r *Repository) ResolveRevision(inplumbing.Revision) (*plumbing.Hash,error)

ResolveRevision resolves revision to corresponding hash. It will alwaysresolve to a commit hash, not a tree or annotated tag.

Implemented resolvers : HEAD, branch, tag, heads/branch, refs/heads/branch,refs/tags/tag, refs/remotes/origin/branch, refs/remotes/origin/HEAD, tilde and caret (HEAD~1, master~^, tag~2, ref/heads/master~1, ...), selection by text (HEAD^{/fix nasty bug}), hash (prefix and full)

func (*Repository)SetConfig¶added inv5.1.0

func (r *Repository) SetConfig(cfg *config.Config)error

SetConfig marshall and writes the repository config. In a filesystem backedrepository this means write the `.git/config`. This function should be calledwith the result of `Repository.Config` and never with the output of`Repository.ConfigScoped`.

func (*Repository)Tag¶

func (r *Repository) Tag(namestring) (*plumbing.Reference,error)

Tag returns a tag from the repository.

If you want to check to see if the tag is an annotated tag, you can callTagObject on the hash of the reference in ForEach:

ref, err := r.Tag("v0.1.0")if err != nil {  // Handle error}obj, err := r.TagObject(ref.Hash())switch err {case nil:  // Tag object presentcase plumbing.ErrObjectNotFound:  // Not a tag objectdefault:  // Some other error}

func (*Repository)TagObject¶

func (r *Repository) TagObject(hplumbing.Hash) (*object.Tag,error)

TagObject returns a Tag with the given hash. If not foundplumbing.ErrObjectNotFound is returned. This method only returnsannotated Tags, no lightweight Tags.

func (*Repository)TagObjects¶

func (r *Repository) TagObjects() (*object.TagIter,error)

TagObjects returns a unsorted TagIter that can step through all of the annotatedtags in the repository.

func (*Repository)Tags¶

func (r *Repository) Tags() (storer.ReferenceIter,error)

Tags returns all the tag References in a repository.

If you want to check to see if the tag is an annotated tag, you can callTagObject on the hash Reference passed in through ForEach:

iter, err := r.Tags()if err != nil {  // Handle error}if err := iter.ForEach(func (ref *plumbing.Reference) error {  obj, err := r.TagObject(ref.Hash())  switch err {  case nil:    // Tag object present  case plumbing.ErrObjectNotFound:    // Not a tag object  default:    // Some other error    return err  }}); err != nil {  // Handle outer iterator error}

func (*Repository)TreeObject¶

func (r *Repository) TreeObject(hplumbing.Hash) (*object.Tree,error)

TreeObject return a Tree with the given hash. If not foundplumbing.ErrObjectNotFound is returned

func (*Repository)TreeObjects¶

func (r *Repository) TreeObjects() (*object.TreeIter,error)

TreeObjects returns an unsorted TreeIter with all the trees in the repository

func (*Repository)Worktree¶

func (r *Repository) Worktree() (*Worktree,error)

Worktree returns a worktree based on the given fs, if nil the defaultworktree will be used.

type ResetModeint8

type ResetOptions struct {// Commit, if commit is present set the current branch head (HEAD) to it.Commitplumbing.Hash// Mode, form resets the current branch head to Commit and possibly updates// the index (resetting it to the tree of Commit) and the working tree// depending on Mode. If empty MixedReset is used.ModeResetMode// Files, if not empty will constrain the reseting the index to only files// specified in this list.Files []string}

func (*ResetOptions)Validate¶

func (o *ResetOptions) Validate(r *Repository)error

Validate validates the fields and sets the default values.

type RestoreOptions struct {// Marks to restore the content in the indexStagedbool// Marks to restore the content of the working treeWorktreebool// List of file paths that will be restoredFiles []string}

func (*RestoreOptions)Validate¶added inv5.13.0

func (o *RestoreOptions) Validate()error

Validate validates the fields and sets the default values.

type Signer interface {Sign(messageio.Reader) ([]byte,error)}

type Status map[string]*FileStatus

func (Status)File¶

func (sStatus) File(pathstring) *FileStatus

File returns the FileStatus for a given path, if the FileStatus doesn'texists a new FileStatus is added to the map using the path as key.

func (Status)IsClean¶

func (sStatus) IsClean()bool

IsClean returns true if all the files are in Unmodified status.

func (Status)IsUntracked¶

func (sStatus) IsUntracked(pathstring)bool

IsUntracked checks if file for given path is 'Untracked'

func (Status)String¶

func (sStatus) String()string

type StatusCodebyte

type StatusOptions struct {StrategyStatusStrategy}

type StatusStrategyint

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

func (*Submodule)Config¶

func (s *Submodule) Config() *config.Submodule

Config returns the submodule config

func (*Submodule)Init¶

func (s *Submodule) Init()error

Init initialize the submodule reading the recorded Entry in the index forthe given submodule

func (*Submodule)Repository¶

func (s *Submodule) Repository() (*Repository,error)

Repository returns the Repository represented by this submodule

func (*Submodule)Status¶

func (s *Submodule) Status() (*SubmoduleStatus,error)

Status returns the status of the submodule.

func (*Submodule)Update¶

func (s *Submodule) Update(o *SubmoduleUpdateOptions)error

Update the registered submodule to match what the superproject expects, thesubmodule should be initialized first calling the Init method or setting inthe options SubmoduleUpdateOptions.Init equals true

func (*Submodule)UpdateContext¶

func (s *Submodule) UpdateContext(ctxcontext.Context, o *SubmoduleUpdateOptions)error

UpdateContext the registered submodule to match what the superprojectexpects, the submodule should be initialized first calling the Init method orsetting in the options SubmoduleUpdateOptions.Init equals true.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

type SubmoduleRescursivityuint

type SubmoduleStatus struct {PathstringCurrentplumbing.HashExpectedplumbing.HashBranchplumbing.ReferenceName}

func (*SubmoduleStatus)IsClean¶

func (s *SubmoduleStatus) IsClean()bool

IsClean is the HEAD of the submodule is equals to the expected commit

func (*SubmoduleStatus)String¶

func (s *SubmoduleStatus) String()string

String is equivalent to `git submodule status <submodule>`

This will print the SHA-1 of the currently checked out commit for asubmodule, along with the submodule path and the output of git describe fothe SHA-1. Each SHA-1 will be prefixed with - if the submodule is notinitialized, + if the currently checked out submodule commit does not matchthe SHA-1 found in the index of the containing repository.

type SubmoduleUpdateOptions struct {// Init, if true initializes the submodules recorded in the index.Initbool// NoFetch tell to the update command to not fetch new objects from the// remote site.NoFetchbool// RecurseSubmodules the update is performed not only in the submodules of// the current repository but also in any nested submodules inside those// submodules (and so on). Until the SubmoduleRescursivity is reached.RecurseSubmodulesSubmoduleRescursivity// Auth credentials, if required, to use with the remote repository.Authtransport.AuthMethod// Depth limit fetching to the specified number of commits from the tip of// each remote branch history.Depthint}

type Submodules []*Submodule

func (Submodules)Init¶

func (sSubmodules) Init()error

Init initializes the submodules in this list.

func (Submodules)Status¶

func (sSubmodules) Status() (SubmodulesStatus,error)

Status returns the status of the submodules.

func (Submodules)Update¶

func (sSubmodules) Update(o *SubmoduleUpdateOptions)error

Update updates all the submodules in this list.

func (Submodules)UpdateContext¶

func (sSubmodules) UpdateContext(ctxcontext.Context, o *SubmoduleUpdateOptions)error

UpdateContext updates all the submodules in this list.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

type SubmodulesStatus []*SubmoduleStatus

func (SubmodulesStatus)String¶

func (sSubmodulesStatus) String()string

String is equivalent to `git submodule status`

type TagModeint

type Worktree struct {// Filesystem underlying filesystem.Filesystembilly.Filesystem// External excludes not found in the repository .gitignoreExcludes []gitignore.Pattern// contains filtered or unexported fields}

func (*Worktree)Add¶

func (w *Worktree) Add(pathstring) (plumbing.Hash,error)

Add adds the file contents of a file in the worktree to the index. if thefile is already staged in the index no error is returned. If a file deletedfrom the Workspace is given, the file is removed from the index. If adirectory given, adds the files and all his sub-directories recursively inthe worktree to the index. If any of the files is already staged in the indexno error is returned. When path is a file, the blob.Hash is returned.

func (*Worktree)AddGlob¶

func (w *Worktree) AddGlob(patternstring)error

AddGlob adds all paths, matching pattern, to the index. If pattern matches adirectory path, all directory contents are added to the index recursively. Noerror is returned if all matching paths are already staged in index.

func (*Worktree)AddWithOptions¶added inv5.2.0

func (w *Worktree) AddWithOptions(opts *AddOptions)error

AddWithOptions file contents to the index, updates the index using thecurrent content found in the working tree, to prepare the content staged forthe next commit.

It typically adds the current content of existing paths as a whole, but withsome options it can also be used to add content with only part of the changesmade to the working tree files applied, or remove paths that do not exist inthe working tree anymore.

func (*Worktree)Checkout¶

func (w *Worktree) Checkout(opts *CheckoutOptions)error

Checkout switch branches or restore working tree files.

func (*Worktree)Clean¶

func (w *Worktree) Clean(opts *CleanOptions)error

Clean the worktree by removing untracked files.An empty dir could be removed - this is what `git clean -f -d .` does.

func (*Worktree)Commit¶

func (w *Worktree) Commit(msgstring, opts *CommitOptions) (plumbing.Hash,error)

Commit stores the current contents of the index in a new commit along witha log message from the user describing the changes.

func (*Worktree)Grep¶

func (w *Worktree) Grep(opts *GrepOptions) ([]GrepResult,error)

Grep performs grep on a worktree.

func (*Worktree)Move¶

func (w *Worktree) Move(from, tostring) (plumbing.Hash,error)

Move moves or rename a file in the worktree and the index, directories arenot supported.

func (*Worktree)Pull¶

func (w *Worktree) Pull(o *PullOptions)error

Pull incorporates changes from a remote repository into the current branch.Returns nil if the operation is successful, NoErrAlreadyUpToDate if there areno changes to be fetched, or an error.

Pull only supports merges where the can be resolved as a fast-forward.

func (*Worktree)PullContext¶

func (w *Worktree) PullContext(ctxcontext.Context, o *PullOptions)error

PullContext incorporates changes from a remote repository into the currentbranch. Returns nil if the operation is successful, NoErrAlreadyUpToDate ifthere are no changes to be fetched, or an error.

Pull only supports merges where the can be resolved as a fast-forward.

The provided Context must be non-nil. If the context expires before theoperation is complete, an error is returned. The context only affects thetransport operations.

func (*Worktree)Remove¶

func (w *Worktree) Remove(pathstring) (plumbing.Hash,error)

Remove removes files from the working tree and from the index.

func (*Worktree)RemoveGlob¶

func (w *Worktree) RemoveGlob(patternstring)error

RemoveGlob removes all paths, matching pattern, from the index. If patternmatches a directory path, all directory contents are removed from the indexrecursively.

func (*Worktree)Reset¶

func (w *Worktree) Reset(opts *ResetOptions)error

Reset the worktree to a specified state.

func (*Worktree)ResetSparsely¶added inv5.5.0

func (w *Worktree) ResetSparsely(opts *ResetOptions, dirs []string)error

func (*Worktree)Restore¶added inv5.13.0

func (w *Worktree) Restore(o *RestoreOptions)error

Restore restores specified files in the working tree or stage with contents froma restore source. If a path is tracked but does not exist in the restore,source, it will be removed to match the source.

If Staged and Worktree are true, then the restore source will be the index.If only Staged is true, then the restore source will be HEAD.If only Worktree is true or neither Staged nor Worktree are true, willresult in ErrRestoreWorktreeOnlyNotSupported because restoring the workingtree while leaving the stage untouched is not currently supported.

Restore with no files specified will return ErrNoRestorePaths.

func (*Worktree)Status¶

func (w *Worktree) Status() (Status,error)

Status returns the working tree status.

func (*Worktree)StatusWithOptions¶added inv5.13.0

func (w *Worktree) StatusWithOptions(oStatusOptions) (Status,error)

StatusWithOptions returns the working tree status.

func (*Worktree)Submodule¶

func (w *Worktree) Submodule(namestring) (*Submodule,error)

Submodule returns the submodule with the given name

func (*Worktree)Submodules¶

func (w *Worktree) Submodules() (Submodules,error)

Submodules returns all the available submodules