index.md

layout	default
menu_item	api
title	API Docs
description	Version 0.21.1
sections	AnnotatedCommit Attr Blame BlameHunk BlameOptions Blob Branch Buf Cert CertHostkey CertX509 Checkout CheckoutOptions Cherrypick CherrypickOptions Clone CloneOptions Commit Config ConfigEntry ConvenientPatch Cred CredUsername CredUserpassPayload CvarMap DescribeFormatOptions DescribeOptions Diff DiffBinary DiffBinaryFile DiffDelta DiffFile DiffFindOptions DiffHunk DiffLine DiffOptions DiffPerfdata Enums Error Fetch FetchOptions Filter FilterList FilterSource Giterr Graph Hashsig Ignore Index IndexEntry IndexTime Indexer Libgit2 Merge MergeFileInput MergeFileOptions MergeFileResult MergeOptions Note Object Odb OdbExpandId OdbObject Oid Oidarray Openssl Packbuilder Patch Pathspec Proxy ProxyOptions Push PushOptions PushUpdate Rebase RebaseOperation RebaseOptions Refdb Reference Reflog ReflogEntry Refspec Remote RemoteCallbacks RemoteHead Repository RepositoryInitOptions Reset Revert RevertOptions Revparse Revwalk Signature Stash StashApplyOptions Status StatusEntry StatusList StatusOptions Strarray Submodule SubmoduleUpdateOptions Tag Time Trace TransferProgress Transport Tree TreeEntry TreeUpdate Treebuilder #AnnotatedCommit #Attr #Blame #BlameHunk #BlameOptions #Blob #Branch #Buf #Cert #CertHostkey #CertX509 #Checkout #CheckoutOptions #Cherrypick #CherrypickOptions #Clone #CloneOptions #Commit #Config #ConfigEntry #ConvenientPatch #Cred #CredUsername #CredUserpassPayload #CvarMap #DescribeFormatOptions #DescribeOptions #Diff #DiffBinary #DiffBinaryFile #DiffDelta #DiffFile #DiffFindOptions #DiffHunk #DiffLine #DiffOptions #DiffPerfdata #Enums #Error #Fetch #FetchOptions #Filter #FilterList #FilterSource #Giterr #Graph #Hashsig #Ignore #Index #IndexEntry #IndexTime #Indexer #Libgit2 #Merge #MergeFileInput #MergeFileOptions #MergeFileResult #MergeOptions #Note #Object #Odb #OdbExpandId #OdbObject #Oid #Oidarray #Openssl #Packbuilder #Patch #Pathspec #Proxy #ProxyOptions #Push #PushOptions #PushUpdate #Rebase #RebaseOperation #RebaseOptions #Refdb #Reference #Reflog #ReflogEntry #Refspec #Remote #RemoteCallbacks #RemoteHead #Repository #RepositoryInitOptions #Reset #Revert #RevertOptions #Revparse #Revwalk #Signature #Stash #StashApplyOptions #Status #StatusEntry #StatusList #StatusOptions #Strarray #Submodule #SubmoduleUpdateOptions #Tag #Time #Trace #TransferProgress #Transport #Tree #TreeEntry #TreeUpdate #Treebuilder

AnnotatedCommit

Class Methods
AnnotatedCommit.fromFetchhead (repo, branch_name, remote_url, id)	Async
AnnotatedCommit.fromRef (repo, ref)	Async
AnnotatedCommit.fromRevspec (repo, revspec)	Async
AnnotatedCommit.lookup (repo, id)	Async

Instance Methods
AnnotatedCommit#free ()	Sync
AnnotatedCommit#id ()	Sync

Attr

Class Methods
Attr.addMacro (repo, name, values)	Sync
Attr.cacheFlush (repo)	Sync
Attr.get (repo, flags, path, name)	Async
Attr.getMany (repo, flags, path, num_attr, names)	Sync
Attr.value (attr)	Sync

ENUMS
Attr.STATES

Blame

Class Methods
Blame.file (repo, path, [options])	Async
Blame.initOptions (opts, version)	Sync

Instance Methods
Blame#buffer (buffer, buffer_len)	Async
Blame#free ()	Sync
Blame#getHunkByIndex (index)	Sync
Blame#getHunkByLine (lineno)	Sync
Blame#getHunkCount ()	Sync

ENUMS
Blame.FLAG

BlameHunk

Instance Variables
BlameHunk#finalCommitId
BlameHunk#finalSignature
BlameHunk#finalStartLineNumber
BlameHunk#linesInHunk
BlameHunk#origCommitId
BlameHunk#origPath
BlameHunk#origSignature
BlameHunk#origStartLineNumber

BlameOptions

Instance Variables
BlameOptions#flags
BlameOptions#maxLine
BlameOptions#minLine
BlameOptions#minMatchCharacters
BlameOptions#newestCommit
BlameOptions#oldestCommit
BlameOptions#version

Blob

Class Methods
Blob.createFromBuffer (repo, buffer, len)	Async
Blob.createFromDisk (repo, path)	Async
Blob.createFromStream (repo, hintpath)	Async
Blob.createFromWorkdir (repo, relative_path)	Async
Blob.createFromstreamCommit (stream)	Async
Blob.filteredContent (blob, as_path, check_for_binary_data)	Async
Blob.lookup (repo, id)	Async
Blob.lookupPrefix (repo, id, len)	Async

Instance Methods
Blob#content ()	Sync
Blob#dup ()	Async
Blob#filemode ()	Sync
Blob#free ()	Sync
Blob#id ()	Sync
Blob#isBinary ()	Sync
Blob#owner ()	Sync
Blob#rawcontent ()	Sync
Blob#rawsize ()	Sync
Blob#toString ()	Sync

Branch

Class Methods
Branch.create (repo, branch_name, target, force)	Async
Branch.createFromAnnotated (repository, branch_name, commit, force)	Async
Branch.delete (branch)	Sync
Branch.isHead (branch)	Sync
Branch.iteratorNew (repo, list_flags)	Async
Branch.lookup (repo, branch_name, branch_type)	Async
Branch.move (branch, new_branch_name, force)	Async
Branch.name (ref)	Async
Branch.remoteName (repo, the)	Async
Branch.setUpstream (branch, upstream_name)	Async
Branch.upstream (branch)	Async

ENUMS
Branch.BRANCH

Buf

Instance Methods
Buf#containsNul ()	SyncExperimental
Buf#free ()	SyncExperimental
Buf#grow (target_size)	AsyncExperimental
Buf#isBinary ()	SyncExperimental
Buf#set (data, datalen)	AsyncExperimental

Instance Variables
Buf#asize
Buf#ptr
Buf#size

Cert

ENUMS
Cert.SSH
Cert.TYPE

Instance Variables
Cert#certType

CertHostkey

Instance Variables
CertHostkey#hashMd5
CertHostkey#hashSha1
CertHostkey#parent
CertHostkey#type

CertX509

Instance Variables
CertX509#data
CertX509#len
CertX509#parent

Checkout

Class Methods
Checkout.head (repo, [options])	Async
Checkout.index (repo, index, [options])	Async
Checkout.initOptions (opts, version)	Sync
Checkout.tree (repo, treeish, [options])	Async

ENUMS
Checkout.NOTIFY
Checkout.STRATEGY

CheckoutOptions

Instance Variables
CheckoutOptions#ancestorLabel
CheckoutOptions#baseline
CheckoutOptions#baselineIndex
CheckoutOptions#checkoutStrategy
CheckoutOptions#dirMode
CheckoutOptions#disableFilters
CheckoutOptions#fileMode
CheckoutOptions#fileOpenFlags
CheckoutOptions#notifyCb
CheckoutOptions#notifyFlags
CheckoutOptions#notifyPayload
CheckoutOptions#ourLabel
CheckoutOptions#paths
CheckoutOptions#perfdataCb
CheckoutOptions#perfdataPayload
CheckoutOptions#progressCb
CheckoutOptions#progressPayload
CheckoutOptions#targetDirectory
CheckoutOptions#theirLabel
CheckoutOptions#version

Cherrypick

Class Methods
Cherrypick.cherrypick (repo, commit, [options])	Async
Cherrypick.commit (repo, cherrypick_commit, our_commit, mainline, [merge_options])	Async
Cherrypick.initOptions (opts, version)	Sync

CherrypickOptions

Instance Variables
CherrypickOptions#checkoutOpts
CherrypickOptions#mainline
CherrypickOptions#mergeOpts
CherrypickOptions#version

Clone

Class Methods
Clone.clone (url, local_path, [options])	Async
Clone.initOptions (opts, version)	Sync

ENUMS
Clone.LOCAL

CloneOptions

Instance Variables
CloneOptions#bare
CloneOptions#checkoutBranch
CloneOptions#checkoutOpts
CloneOptions#fetchOpts
CloneOptions#local
CloneOptions#remoteCbPayload
CloneOptions#repositoryCbPayload
CloneOptions#version

Commit

Class Methods
Commit.create (repo, update_ref, author, committer, message_encoding, message, tree, parent_count, parents)	Async
Commit.createV (id, repo, update_ref, author, committer, message_encoding, message, tree, parent_count)	Sync
Commit.createWithSignature (repo, commit_content, signature, signature_field)	Async
Commit.lookup (repo, id)	Async
Commit.lookupPrefix (repo, id, len)	Async

Instance Methods
Commit#amend (update_ref, author, committer, message_encoding, message, tree, callback)	Async
Commit#author ()	Sync
Commit#body ()	Sync
Commit#committer ()	Sync
Commit#date ()	Sync
Commit#dup ()	Async
Commit#free ()	Sync
Commit#getDiff (callback)	Async
Commit#getDiffWithOptions (options, callback)	Async
Commit#getEntry (path)	Async
Commit#getParents (limit, callback)	Async
Commit#getTree ()	Async
Commit#headerField (field)	Async
Commit#history ()	Sync
Commit#id ()	Sync
Commit#message ()	Sync
Commit#messageEncoding ()	Sync
Commit#messageRaw ()	Sync
Commit#nthGenAncestor (n)	Async
Commit#owner ()	Sync
Commit#parent (n)	Async
Commit#parentId (n)	Sync
Commit#parentcount ()	Sync
Commit#parents ()	Sync
Commit#rawHeader ()	Sync
Commit#sha ()	Sync
Commit#summary ()	Sync
Commit#time ()	Sync
Commit#timeMs ()	Sync
Commit#timeOffset ()	Sync
Commit#toString ()	Sync
Commit#tree (tree_out)	Sync
Commit#treeId ()	Sync

Config

Class Methods
Config.findProgramdata ()	Async
Config.openDefault ()	Async

Instance Methods
Config#getStringBuf (name)	Async
Config#lock (tx)	Sync
Config#setInt64 (name, value)	Sync
Config#setMultivar (name, regexp, value)	Sync
Config#setString (name, value)	Async
Config#snapshot ()	Async

ENUMS
Config.LEVEL

ConfigEntry

Instance Variables
ConfigEntry#free
ConfigEntry#level
ConfigEntry#name
ConfigEntry#payload
ConfigEntry#value

ConvenientPatch

Instance Methods
ConvenientPatch#hunks ()	Async
ConvenientPatch#isAdded ()	Sync
ConvenientPatch#isConflicted ()	Sync
ConvenientPatch#isCopied ()	Sync
ConvenientPatch#isDeleted ()	Sync
ConvenientPatch#isIgnored ()	Sync
ConvenientPatch#isModified ()	Sync
ConvenientPatch#isRenamed ()	Sync
ConvenientPatch#isTypeChange ()	Sync
ConvenientPatch#isUnmodified ()	Sync
ConvenientPatch#isUnreadable ()	Sync
ConvenientPatch#isUntracked ()	Sync
ConvenientPatch#lineStats ()	Sync
ConvenientPatch#newFile ()	Sync
ConvenientPatch#oldFile ()	Sync
ConvenientPatch#size ()	Sync
ConvenientPatch#status ()	Sync

Cred

Class Methods
Cred.defaultNew ()	Sync
Cred.sshKeyFromAgent (username)	Sync
Cred.sshKeyMemoryNew (username, publickey, privatekey, passphrase)	Async
Cred.sshKeyNew (username, publickey, privatekey, passphrase)	Sync
Cred.usernameNew (username)	Async
Cred.userpassPlaintextNew (username, password)	Sync

Instance Methods
Cred#free ()	Sync
Cred#hasUsername ()	Sync

ENUMS
Cred.TYPE

CredUsername

Instance Variables
CredUsername#parent
CredUsername#username

CredUserpassPayload

Instance Variables
CredUserpassPayload#password
CredUserpassPayload#username

CvarMap

Instance Variables
CvarMap#cvarType
CvarMap#mapValue
CvarMap#strMatch

DescribeFormatOptions

Instance Variables
DescribeFormatOptions#abbreviatedSize
DescribeFormatOptions#alwaysUseLongFormat
DescribeFormatOptions#dirtySuffix
DescribeFormatOptions#version

DescribeOptions

Instance Variables
DescribeOptions#describeStrategy
DescribeOptions#maxCandidatesTags
DescribeOptions#onlyFollowFirstParent
DescribeOptions#pattern
DescribeOptions#showCommitOidAsFallback
DescribeOptions#version

Diff

Class Methods
Diff.blobToBuffer (old_blob, old_as_path, buffer, buffer_as_path, opts, file_cb, binary_cb, hunk_cb, line_cb)	Async
Diff.fromBuffer (content, content_len)	Async
Diff.indexToIndex (repo, old_index, new_index, opts)	Async
Diff.indexToWorkdir (repo, index, opts)	Async
Diff.treeToIndex (repo, old_tree, index, opts)	Async
Diff.treeToTree (repo, old_tree, new_tree, opts)	Async
Diff.treeToWorkdir (repo, old_tree, opts)	Async
Diff.treeToWorkdirWithIndex (repo, old_tree, opts)	Async

Instance Methods
Diff#findSimilar (options)	Async
Diff#getDelta (idx)	Sync
Diff#getPerfdata ()	Async
Diff#merge (from)	Async
Diff#numDeltas ()	Sync
Diff#patches ()	Async
Diff#toBuf (format)	Async

ENUMS
Diff.DELTA
Diff.FIND
Diff.FLAG
Diff.FORMAT
Diff.FORMAT_EMAIL_FLAGS
Diff.LINE
Diff.OPTION
Diff.STATS_FORMAT

DiffBinary

ENUMS
DiffBinary.DIFF_BINARY

Instance Variables
DiffBinary#containsData
DiffBinary#newFile
DiffBinary#oldFile

DiffBinaryFile

Instance Variables
DiffBinaryFile#data
DiffBinaryFile#datalen
DiffBinaryFile#inflatedlen
DiffBinaryFile#type

DiffDelta

Instance Variables
DiffDelta#flags
DiffDelta#newFile
DiffDelta#nfiles
DiffDelta#oldFile
DiffDelta#similarity
DiffDelta#status

DiffFile

Instance Methods
DiffFile#flags ()	Sync
DiffFile#id ()	Sync
DiffFile#mode ()	Sync
DiffFile#path ()	Sync
DiffFile#size ()	Sync

Instance Variables
DiffFile#flags
DiffFile#id
DiffFile#idAbbrev
DiffFile#mode
DiffFile#path
DiffFile#size

DiffFindOptions

Instance Variables
DiffFindOptions#breakRewriteThreshold
DiffFindOptions#copyThreshold
DiffFindOptions#flags
DiffFindOptions#renameFromRewriteThreshold
DiffFindOptions#renameLimit
DiffFindOptions#renameThreshold
DiffFindOptions#version

DiffHunk

Instance Variables
DiffHunk#header
DiffHunk#headerLen
DiffHunk#newLines
DiffHunk#newStart
DiffHunk#oldLines
DiffHunk#oldStart

DiffLine

Instance Methods
DiffLine#content ()	Sync
DiffLine#rawContent ()	Sync

Instance Variables
DiffLine#content
DiffLine#contentLen
DiffLine#contentOffset
DiffLine#newLineno
DiffLine#numLines
DiffLine#oldLineno
DiffLine#origin

DiffOptions

Instance Variables
DiffOptions#contextLines
DiffOptions#flags
DiffOptions#idAbbrev
DiffOptions#ignoreSubmodules
DiffOptions#interhunkLines
DiffOptions#maxSize
DiffOptions#newPrefix
DiffOptions#notifyCb
DiffOptions#oldPrefix
DiffOptions#pathspec
DiffOptions#payload
DiffOptions#progressCb
DiffOptions#version

DiffPerfdata

Instance Variables
DiffPerfdata#oidCalculations
DiffPerfdata#statCalls
DiffPerfdata#version

Enums

ENUMS
Enums.CVAR
Enums.DIRECTION
Enums.FEATURE
Enums.IDXENTRY_EXTENDED_FLAG
Enums.INDXENTRY_FLAG

Error

ENUMS
Error.CODE
Error.ERROR

Instance Variables
Error#klass
Error#message

Fetch

Class Methods
Fetch.initOptions (opts, version)	SyncExperimental

ENUMS
Fetch.PRUNE

FetchOptions

Instance Variables
FetchOptions#callbacks
FetchOptions#customHeaders
FetchOptions#downloadTags
FetchOptions#proxyOpts
FetchOptions#prune
FetchOptions#updateFetchhead
FetchOptions#version

Filter

Class Methods
Filter.listContains (filters, name)	Sync
Filter.listLength (fl)	Sync
Filter.load (repo, blob, path, mode, flags)	Async
Filter.unregister (name)	Sync

Instance Methods
Filter#applyToBlob (blob)	Async
Filter#applyToData (in)	Async
Filter#applyToFile (repo, path)	Async
Filter#free ()	Sync
Filter#lookup (name)	Sync
Filter#register (name, priority)	Sync

ENUMS
Filter.FLAG
Filter.MODE

Instance Variables
Filter#apply
Filter#attributes
Filter#check
Filter#cleanup
Filter#initialize
Filter#shutdown
Filter#version

FilterList

Class Methods
FilterList.load (repo, blob, path, mode, flags)	AsyncExperimental

Instance Methods
FilterList#applyToBlob (blob)	AsyncExperimental
FilterList#applyToData (in)	AsyncExperimental
FilterList#applyToFile (repo, path)	AsyncExperimental
FilterList#free ()	SyncExperimental

FilterSource

Instance Methods
FilterSource#filemode ()	SyncExperimental
FilterSource#flags ()	SyncExperimental
FilterSource#id ()	SyncExperimental
FilterSource#mode ()	SyncExperimental
FilterSource#path ()	SyncExperimental
FilterSource#repo ()	SyncExperimental

Giterr

Class Methods
Giterr.errClear ()	SyncExperimental
Giterr.errLast ()	SyncExperimental
Giterr.errSetOom ()	SyncExperimental
Giterr.errSetString (error_class, string)	SyncExperimental

Graph

Class Methods
Graph.aheadBehind (repo, local, upstream)	Async
Graph.descendantOf (repo, commit, ancestor)	Async

Hashsig

Class Methods
Hashsig.create (buf, buflen, opts)	AsyncExperimental
Hashsig.createFromFile (path, opts)	AsyncExperimental

Instance Methods
Hashsig#compare (b)	SyncExperimental
Hashsig#free ()	SyncExperimental

ENUMS
Hashsig.OPTION

Ignore

Class Methods
Ignore.addRule (repo, rules)	Sync
Ignore.clearInternalRules (repo)	Sync
Ignore.pathIsIgnored (repo, path)	Async

Index

Class Methods
Index.entryIsConflict (entry)	Sync
Index.entryStage (entry)	Sync
Index.open (index_path)	Async

Instance Methods
Index#add (source_entry)	Async
Index#addAll (pathspec, flags, callback, payload)	Async
Index#addByPath (path)	Async
Index#caps ()	Sync
Index#checksum ()	Sync
Index#clear ()	Async
Index#conflictAdd (ancestor_entry, our_entry, their_entry)	Async
Index#conflictCleanup ()	Async
Index#conflictGet (path)	Async
Index#conflictRemove (path)	Async
Index#entries ()	Sync
Index#entryCount ()	Sync
Index#find (path)	Async
Index#findPrefix (prefix)	Async
Index#getByIndex (n)	Sync
Index#getByPath (path, stage)	Sync
Index#hasConflicts ()	Sync
Index#owner ()	Sync
Index#path ()	Sync
Index#read (force)	Async
Index#readTree (tree)	Async
Index#remove (path, stage)	Async
Index#removeAll (pathspec, callback, payload)	Async
Index#removeByPath (path)	Async
Index#removeDirectory (dir, stage)	Async
Index#setCaps (caps)	Sync
Index#setVersion (version)	Sync
Index#updateAll (pathspec, callback, payload)	Async
Index#version ()	Sync
Index#write ()	Async
Index#writeTree ()	Async
Index#writeTreeTo (repo)	Async

ENUMS
Index.ADD_OPTION
Index.CAP

IndexEntry

Instance Variables
IndexEntry#ctime
IndexEntry#dev
IndexEntry#fileSize
IndexEntry#flags
IndexEntry#flagsExtended
IndexEntry#gid
IndexEntry#id
IndexEntry#ino
IndexEntry#mode
IndexEntry#mtime
IndexEntry#path
IndexEntry#uid

IndexTime

Instance Variables
IndexTime#nanoseconds
IndexTime#seconds

Indexer

Instance Methods
Indexer#commit (stats)	SyncExperimental
Indexer#free ()	SyncExperimental
Indexer#hash ()	SyncExperimental

Libgit2

Class Methods
Libgit2.features ()	SyncExperimental
Libgit2.init ()	SyncExperimental
Libgit2.opts (option)	SyncExperimental
Libgit2.shutdown ()	SyncExperimental
Libgit2.version (major, minor, rev)	SyncExperimental

ENUMS
Libgit2.OPT

Merge

Class Methods
Merge.base (repo, one, two)	Async
Merge.bases (repo, one, two)	Async
Merge.commits (repo, ourCommit, theirCommit, [options])	Sync
Merge.fileInitInput (opts, version)	Sync
Merge.initOptions (opts, version)	Sync
Merge.merge (repo, theirHead, [mergeOpts], [checkoutOpts])	Sync
Merge.trees (repo, ancestor_tree, our_tree, their_tree, opts)	Async

ENUMS
Merge.ANALYSIS
Merge.FILE_FAVOR
Merge.FILE_FLAG
Merge.FLAG
Merge.PREFERENCE

MergeFileInput

Instance Variables
MergeFileInput#mode
MergeFileInput#path
MergeFileInput#ptr
MergeFileInput#size
MergeFileInput#version

MergeFileOptions

Instance Variables
MergeFileOptions#ancestorLabel
MergeFileOptions#favor
MergeFileOptions#flags
MergeFileOptions#ourLabel
MergeFileOptions#theirLabel
MergeFileOptions#version

MergeFileResult

Instance Variables
MergeFileResult#automergeable
MergeFileResult#len
MergeFileResult#mode
MergeFileResult#path
MergeFileResult#ptr

MergeOptions

Instance Variables
MergeOptions#defaultDriver
MergeOptions#fileFavor
MergeOptions#fileFlags
MergeOptions#flags
MergeOptions#recursionLimit
MergeOptions#renameThreshold
MergeOptions#targetLimit
MergeOptions#version

Note

Class Methods
Note.create (repo, notes_ref, author, committer, oid, note, force)	Async
Note.foreach (repo, notes_ref, note_cb, payload)	Async
Note.iteratorNew (repo, notes_ref)	Async
Note.next (note_id, annotated_id, it)	Sync
Note.read (repo, notes_ref, oid)	Async
Note.remove (repo, notes_ref, author, committer, oid)	Async

Instance Methods
Note#author ()	Sync
Note#committer ()	Sync
Note#free ()	Sync
Note#id ()	Sync
Note#message ()	Sync

Object

Class Methods
Object.lookup (repo, id, type)	AsyncExperimental
Object.lookupPrefix (repo, id, len, type)	AsyncExperimental
Object.size (type)	SyncExperimental
Object.string2Type (str)	SyncExperimental
Object.type2String (type)	SyncExperimental
Object.typeisloose (type)	SyncExperimental

Instance Methods
Object#dup ()	AsyncExperimental
Object#free ()	SyncExperimental
Object#id ()	SyncExperimental
Object#lookupByPath (path, type)	AsyncExperimental
Object#owner ()	SyncExperimental
Object#peel (target_type)	AsyncExperimental
Object#shortId ()	AsyncExperimental
Object#type ()	SyncExperimental

ENUMS
Object.TYPE

Odb

Class Methods
Odb.open (objects_dir)	Async

Instance Methods
Odb#addDiskAlternate (path)	Sync
Odb#expandIds (ids, count)	Sync
Odb#free ()	Sync
Odb#read (id)	Async
Odb#write (data, len, type)	Async

ENUMS
Odb.STREAM

OdbExpandId

Instance Variables
OdbExpandId#id
OdbExpandId#length
OdbExpandId#type

OdbObject

Instance Methods
OdbObject#data ()	SyncExperimental
OdbObject#dup ()	AsyncExperimental
OdbObject#free ()	SyncExperimental
OdbObject#id ()	SyncExperimental
OdbObject#size ()	SyncExperimental
OdbObject#type ()	SyncExperimental

Oid

Class Methods
Oid.fromString (str)	Sync

Instance Methods
Oid#cmp (b)	Sync
Oid#cpy ()	Sync
Oid#equal (b)	Sync
Oid#iszero ()	Sync
Oid#ncmp (b, len)	Sync
Oid#strcmp (str)	Sync
Oid#streq (str)	Sync
Oid#tostrS ()	Sync

Oidarray

Instance Methods
Oidarray#free ()	SyncExperimental

Instance Variables
Oidarray#count
Oidarray#ids

Openssl

Class Methods
Openssl.setLocking ()	SyncExperimental

Packbuilder

Class Methods
Packbuilder.create (repo)	Sync

Instance Methods
Packbuilder#free ()	Sync
Packbuilder#hash ()	Sync
Packbuilder#insert (id, name)	Sync
Packbuilder#insertCommit (id)	Sync
Packbuilder#insertRecur (id, name)	Sync
Packbuilder#insertTree (id)	Sync
Packbuilder#insertWalk (walk)	Sync
Packbuilder#objectCount ()	Sync
Packbuilder#setThreads (n)	Sync
Packbuilder#written ()	Sync

ENUMS
Packbuilder.STAGE

Patch

Class Methods
Patch.convenientFromDiff (diff)	Async
Patch.fromBlobAndBuffer (old_blob, old_as_path, buffer, buffer_len, buffer_as_path, opts)	Async
Patch.fromBlobs (old_blob, old_as_path, new_blob, new_as_path, opts)	Async
Patch.fromDiff (diff, idx)	Async

Instance Methods
Patch#getDelta ()	Sync
Patch#getHunk (hunk_idx)	Async
Patch#getLineInHunk (hunk_idx, line_of_hunk)	Async
Patch#lineStats ()	Sync
Patch#numHunks ()	Sync
Patch#numLinesInHunk (hunk_idx)	Sync
Patch#size (include_context, include_hunk_headers, include_file_headers)	Sync

Pathspec

Class Methods
Pathspec.create (pathspec)	Sync
Pathspec.matchListDiffEntry (m, pos)	Sync
Pathspec.matchListEntry (m, pos)	Sync
Pathspec.matchListEntrycount (m)	Sync
Pathspec.matchListFailedEntry (m, pos)	Sync
Pathspec.matchListFailedEntrycount (m)	Sync

Instance Methods
Pathspec#free ()	Sync
Pathspec#matchDiff (diff, flags)	Async
Pathspec#matchIndex (index, flags)	Async
Pathspec#matchTree (tree, flags)	Async
Pathspec#matchWorkdir (repo, flags)	Async
Pathspec#matchesPath (flags, path)	Sync

ENUMS
Pathspec.FLAG

Proxy

Class Methods
Proxy.initOptions (opts, version)	SyncExperimental

ENUMS
Proxy.PROXY

ProxyOptions

Instance Variables
ProxyOptions#certificateCheck
ProxyOptions#credentials
ProxyOptions#payload
ProxyOptions#type
ProxyOptions#url
ProxyOptions#version

Push

Class Methods
Push.initOptions (opts, version)	SyncExperimental

PushOptions

Instance Variables
PushOptions#callbacks
PushOptions#customHeaders
PushOptions#pbParallelism
PushOptions#proxyOpts
PushOptions#version

PushUpdate

Instance Variables
PushUpdate#dst
PushUpdate#dstRefname
PushUpdate#src
PushUpdate#srcRefname

Rebase

Class Methods
Rebase.init (repo, branch, upstream, onto, opts)	Async
Rebase.initOptions (opts, version)	Sync
Rebase.open (repo, options, callback)	Async

Instance Methods
Rebase#abort ()	Async
Rebase#commit (author, committer, message_encoding, message)	Async
Rebase#finish (signature)	Sync
Rebase#inmemoryIndex (index)	Sync
Rebase#next ()	Async
Rebase#operationByIndex (idx)	Sync
Rebase#operationCurrent ()	Sync
Rebase#operationEntrycount ()	Sync

RebaseOperation

ENUMS
RebaseOperation.REBASE_OPERATION

Instance Variables
RebaseOperation#exec
RebaseOperation#id
RebaseOperation#type

RebaseOptions

Instance Variables
RebaseOptions#checkoutOptions
RebaseOptions#mergeOptions
RebaseOptions#quiet
RebaseOptions#rewriteNotesRef
RebaseOptions#version

Refdb

Class Methods
Refdb.open (repo)	AsyncExperimental

Instance Methods
Refdb#compress ()	SyncExperimental
Refdb#free ()	SyncExperimental

Reference

Class Methods
Reference.create (repo, name, id, force, log_message)	AsyncExperimental
Reference.createMatching (repo, name, id, force, current_id, log_message)	AsyncExperimental
Reference.dwim (repo, id, callback)	Async
Reference.ensureLog (repo, refname)	SyncExperimental
Reference.hasLog (repo, refname)	SyncExperimental
Reference.isValidName (refname)	SyncExperimental
Reference.list (repo)	AsyncExperimental
Reference.lookup (repo, id, callback)	Async
Reference.nameToId (repo, name)	AsyncExperimental
Reference.normalizeName (buffer_out, buffer_size, name, flags)	SyncExperimental
Reference.remove (repo, name)	SyncExperimental
Reference.symbolicCreate (repo, name, target, force, log_message)	AsyncExperimental
Reference.symbolicCreateMatching (repo, name, target, force, current_value, log_message)	AsyncExperimental

Instance Methods
Reference#cmp (ref2)	SyncExperimental
Reference#delete ()	SyncExperimental
Reference#dup ()	AsyncExperimental
Reference#isBranch ()	SyncExperimental
Reference#isConcrete ()	Sync
Reference#isHead ()	Sync
Reference#isNote ()	SyncExperimental
Reference#isRemote ()	SyncExperimental
Reference#isSymbolic ()	Sync
Reference#isTag ()	SyncExperimental
Reference#isValid ()	Sync
Reference#name ()	SyncExperimental
Reference#owner ()	SyncExperimental
Reference#peel (type)	AsyncExperimental
Reference#rename (new_name, force, log_message)	AsyncExperimental
Reference#resolve ()	AsyncExperimental
Reference#setTarget (id, log_message)	AsyncExperimental
Reference#shorthand ()	SyncExperimental
Reference#symbolicSetTarget (target, log_message)	AsyncExperimental
Reference#symbolicTarget ()	SyncExperimental
Reference#target ()	SyncExperimental
Reference#targetPeel ()	SyncExperimental
Reference#toString ()	Sync
Reference#type ()	SyncExperimental

ENUMS
Reference.NORMALIZE
Reference.TYPE

Reflog

Class Methods
Reflog.delete (repo, name)	SyncExperimental
Reflog.read (repo, name)	AsyncExperimental
Reflog.rename (repo, old_name, name)	SyncExperimental

Instance Methods
Reflog#append (id, committer, msg)	SyncExperimental
Reflog#drop (idx, rewrite_previous_entry)	SyncExperimental
Reflog#entryByIndex (idx)	SyncExperimental
Reflog#entrycount ()	SyncExperimental
Reflog#free ()	SyncExperimental
Reflog#write ()	AsyncExperimental

ReflogEntry

Instance Methods
ReflogEntry#committer ()	SyncExperimental
ReflogEntry#idNew ()	SyncExperimental
ReflogEntry#idOld ()	SyncExperimental
ReflogEntry#message ()	SyncExperimental

Refspec

Instance Methods
Refspec#direction ()	SyncExperimental
Refspec#dst ()	SyncExperimental
Refspec#dstMatches (refname)	SyncExperimental
Refspec#force ()	SyncExperimental
Refspec#src ()	SyncExperimental
Refspec#srcMatches (refname)	SyncExperimental

Remote

Class Methods
Remote.addFetch (repo, remote, refspec)	Sync
Remote.addPush (repo, remote, refspec)	Sync
Remote.create (repo, name, url)	Async
Remote.createAnonymous (repo, url)	Async
Remote.createWithFetchspec (repo, name, url, fetch)	Async
Remote.delete (repo, name)	Async
Remote.initCallbacks (opts, version)	Sync
Remote.isValidName (remote_name)	Sync
Remote.list (repo)	Async
Remote.lookup (repo, name, callback)	Async
Remote.setAutotag (repo, remote, value)	Sync
Remote.setPushurl (repo, remote, url)	Sync
Remote.setUrl (repo, remote, url)	Sync

Instance Methods
Remote#autotag ()	Sync
Remote#connect (direction, callbacks, proxyOpts, customHeaders, callback)	Async
Remote#connected ()	Sync
Remote#defaultBranch ()	Async
Remote#disconnect ()	Async
Remote#download (refSpecs, opts, callback)	Async
Remote#dup ()	Async
Remote#fetch (refSpecs, opts, message, callback)	Async
Remote#free ()	Sync
Remote#getFetchRefspecs ()	Async
Remote#getPushRefspecs ()	Async
Remote#getRefspec (n)	Sync
Remote#name ()	Sync
Remote#owner ()	Sync
Remote#prune (callbacks)	Sync
Remote#pruneRefs ()	Sync
Remote#push (refSpecs, options, callback)	Async
Remote#pushurl ()	Sync
Remote#referenceList ()	Async
Remote#refspecCount ()	Sync
Remote#stats ()	Sync
Remote#stop ()	Sync
Remote#updateTips (callbacks, update_fetchhead, download_tags, reflog_message)	Sync
Remote#upload (refSpecs, options, callback)	Async
Remote#url ()	Sync

ENUMS
Remote.AUTOTAG_OPTION
Remote.COMPLETION_TYPE

RemoteCallbacks

Instance Variables
RemoteCallbacks#certificateCheck
RemoteCallbacks#credentials
RemoteCallbacks#payload
RemoteCallbacks#pushUpdateReference
RemoteCallbacks#transferProgress
RemoteCallbacks#transport
RemoteCallbacks#version

RemoteHead

Instance Variables
RemoteHead#local
RemoteHead#loid
RemoteHead#name
RemoteHead#oid
RemoteHead#symrefTarget

Repository

Class Methods
Repository.discover (startPath, acrossFs, ceilingDirs)	Async
Repository.init (path, is_bare)	Async
Repository.initExt (repo_path, opts)	Async
Repository.open (path)	Async
Repository.openBare (bare_path)	Async
Repository.openExt (path, flags, ceiling_dirs)	Async
Repository.wrapOdb (odb)	Async

Instance Methods
Repository#checkoutBranch (branch, opts)	Async
Repository#checkoutRef (reference, opts)	Async
Repository#cleanup ()	Sync
Repository#config ()	Async
Repository#configSnapshot ()	Async
Repository#continueRebase (signature, beforeNextFn, beforeFinishFn)	Async
Repository#createBlobFromBuffer (buffer)	Sync
Repository#createBranch (name, commit, force)	Async
Repository#createCommit (updateRef, author, committer, message, Tree, parents)	Async
Repository#createCommitOnHead (filesToAdd, author, committer, message)	Async
Repository#createLightweightTag (String, name)	Async
Repository#createRevWalk (String)	Sync
Repository#createTag (String, name, message)	Async
Repository#defaultSignature ()	Sync
Repository#deleteTagByName (Short)	Async
Repository#detachHead ()	Sync
Repository#fetch (remote, fetchOptions)	Async
Repository#fetchAll (fetchOptions, callback)	Async
Repository#fetchheadForeach (callback)	Async
Repository#free ()	Sync
Repository#getBlob (String)	Async
Repository#getBranch (name)	Async
Repository#getBranchCommit (name)	Async
Repository#getCommit (String)	Async
Repository#getCurrentBranch ()	Async
Repository#getHeadCommit ()	Async
Repository#getMasterCommit ()	Async
Repository#getNamespace ()	Sync
Repository#getReference (name)	Async
Repository#getReferenceCommit (name)	Async
Repository#getReferenceNames (type)	Async
Repository#getReferences (type)	Async
Repository#getRemote (remote, callback)	Async
Repository#getRemotes (Optional)	Async
Repository#getStatus (opts)	Async
Repository#getStatusExt (opts)	Async
Repository#getSubmoduleNames ()	Async
Repository#getTag (String)	Async
Repository#getTagByName (Short)	Async
Repository#getTree (String)	Async
Repository#head ()	Async
Repository#headDetached ()	Sync
Repository#headUnborn ()	Sync
Repository#index ()	Async
Repository#isApplyingMailbox ()	Sync
Repository#isBare ()	Sync
Repository#isBisecting ()	Sync
Repository#isCherrypicking ()	Sync
Repository#isDefaultState ()	Sync
Repository#isEmpty ()	Sync
Repository#isMerging ()	Sync
Repository#isRebasing ()	Sync
Repository#isReverting ()	Sync
Repository#isShallow ()	Sync
Repository#mergeBranches (to, from, signature, mergePreference, mergeOptions)	Async
Repository#mergeheadForeach (callback)	Async
Repository#messageRemove ()	Sync
Repository#odb ()	Async
Repository#path ()	Sync
Repository#rebaseBranches (branch, upstream, onto, signature, beforeNextFn, beforeFinishFn)	Async
Repository#refdb ()	Async
Repository#refreshIndex ()	Async
Repository#setHead (refname)	Async
Repository#setHeadDetached (commitish)	Sync
Repository#setHeadDetachedFromAnnotated (commitish)	Sync
Repository#setIdent (name, email)	Sync
Repository#setIndex (index)	Sync
Repository#setNamespace (nmspace)	Sync
Repository#setWorkdir (workdir, update_gitlink)	Sync
Repository#stageFilemode (filePath, stageNew)	Async
Repository#stageLines (filePath, selectedLines, isStaged)	Async
Repository#state ()	Sync
Repository#stateCleanup ()	Sync
Repository#submoduleCacheAll ()	Sync
Repository#submoduleCacheClear ()	Sync
Repository#treeBuilder (tree)	Sync
Repository#workdir ()	Sync

ENUMS
Repository.INIT_FLAG
Repository.INIT_MODE
Repository.OPEN_FLAG
Repository.STATE

RepositoryInitOptions

Instance Variables
RepositoryInitOptions#description
RepositoryInitOptions#flags
RepositoryInitOptions#initialHead
RepositoryInitOptions#mode
RepositoryInitOptions#originUrl
RepositoryInitOptions#templatePath
RepositoryInitOptions#version
RepositoryInitOptions#workdirPath

Reset

Class Methods
Reset.default (repo, target, pathspecs)	Async
Reset.fromAnnotated (repo, target, resetType, opts)	Async
Reset.reset (repo, target, resetType, opts, name)	Async

ENUMS
Reset.TYPE

Revert

Class Methods
Revert.commit (repo, revert_commit, our_commit, mainline, merge_options)	Async
Revert.revert (repo, commit, revert_options)	Async

RevertOptions

Instance Variables
RevertOptions#checkoutOpts
RevertOptions#mainline
RevertOptions#mergeOpts
RevertOptions#version

Revparse

Class Methods
Revparse.ext (object_out, reference_out, repo, spec)	Sync
Revparse.single (repo, spec)	Async

ENUMS
Revparse.MODE

Revwalk

Class Methods
Revwalk.create (repo)	Sync

Instance Methods
Revwalk#fastWalk (max_count)	Async
Revwalk#fileHistoryWalk (filePath, max_count)	Async
Revwalk#free ()	Sync
Revwalk#getCommits (count)	Async
Revwalk#getCommitsUntil (checkFn)	Async
Revwalk#hide (commit_id)	Sync
Revwalk#hideGlob (glob)	Sync
Revwalk#hideHead ()	Sync
Revwalk#hideRef (refname)	Sync
Revwalk#next ()	Async
Revwalk#push (id)	Sync
Revwalk#pushGlob (glob)	Sync
Revwalk#pushHead ()	Sync
Revwalk#pushRange (range)	Sync
Revwalk#pushRef (refname)	Sync
Revwalk#repository ()	Sync
Revwalk#reset ()	Sync
Revwalk#simplifyFirstParent ()	Sync
Revwalk#sorting (sort)	Sync
Revwalk#walk (oid, callback)	Sync

ENUMS
Revwalk.SORT

Signature

Class Methods
Signature.create (name, email, time, offset)	Sync
Signature.default (repo)	Sync
Signature.fromBuffer (buf)	Async
Signature.now (name, email)	Sync

Instance Methods
Signature#dup ()	Async
Signature#free ()	Sync
Signature#toString ()	Sync

Instance Variables
Signature#email
Signature#name
Signature#when

Stash

Class Methods
Stash.apply (repo, index, options)	Async
Stash.applyInitOptions (opts, version)	Sync
Stash.drop (repo, index)	Async
Stash.foreach (repo, callback, payload)	Async
Stash.pop (repo, index, options)	Async
Stash.save (repo, stasher, message, flags)	Async

ENUMS
Stash.APPLY_FLAGS
Stash.APPLY_PROGRESS
Stash.FLAGS

StashApplyOptions

Instance Variables
StashApplyOptions#checkoutOptions
StashApplyOptions#flags
StashApplyOptions#progressCb
StashApplyOptions#progressPayload
StashApplyOptions#version

Status

Class Methods
Status.byIndex (statuslist, idx)	Sync
Status.file (repo, path)	Async
Status.foreach (repo, callback, payload)	Async
Status.foreachExt (repo, opts, callback, payload)	Async
Status.shouldIgnore (ignored, repo, path)	Sync

ENUMS
Status.OPT
Status.SHOW
Status.STATUS

StatusEntry

Instance Variables
StatusEntry#headToIndex
StatusEntry#indexToWorkdir
StatusEntry#status

StatusList

Class Methods
StatusList.create (repo, opts)	Async

Instance Methods
StatusList#entrycount ()	Sync
StatusList#free ()	Sync
StatusList#getPerfdata ()	Async

StatusOptions

Instance Variables
StatusOptions#flags
StatusOptions#pathspec
StatusOptions#show
StatusOptions#version

Strarray

Instance Methods
Strarray#copy (src)	SyncExperimental
Strarray#free ()	SyncExperimental

Instance Variables
Strarray#count
Strarray#strings

Submodule

Class Methods
Submodule.addSetup (repo, url, path, use_gitlink)	Async
Submodule.foreach (repo, callback, payload)	Async
Submodule.lookup (repo, name)	Async
Submodule.resolveUrl (repo, url)	Async
Submodule.setBranch (repo, name, branch)	Sync
Submodule.setFetchRecurseSubmodules (repo, name, fetch_recurse_submodules)	Sync
Submodule.setIgnore (repo, name, ignore)	Async
Submodule.setUpdate (repo, name, update)	Async
Submodule.setUrl (repo, name, url)	Async
Submodule.status (repo, name, ignore)	Async
Submodule.updateInitOptions (opts, version)	Sync

Instance Methods
Submodule#addFinalize ()	Async
Submodule#addToIndex (write_index)	Async
Submodule#branch ()	Sync
Submodule#fetchRecurseSubmodules ()	Sync
Submodule#free ()	Sync
Submodule#headId ()	Sync
Submodule#ignore ()	Sync
Submodule#indexId ()	Sync
Submodule#init (overwrite)	Async
Submodule#location ()	Async
Submodule#name ()	Sync
Submodule#open ()	Async
Submodule#owner ()	Sync
Submodule#path ()	Sync
Submodule#reload (force)	Sync
Submodule#repoInit (use_gitlink)	Async
Submodule#sync ()	Async
Submodule#update (init, options)	Async
Submodule#updateStrategy ()	Sync
Submodule#url ()	Sync
Submodule#wdId ()	Sync

ENUMS
Submodule.IGNORE
Submodule.RECURSE
Submodule.STATUS
Submodule.UPDATE

SubmoduleUpdateOptions

Instance Variables
SubmoduleUpdateOptions#allowFetch
SubmoduleUpdateOptions#checkoutOpts
SubmoduleUpdateOptions#fetchOpts
SubmoduleUpdateOptions#version

Tag

Class Methods
Tag.annotationCreate (repo, tag_name, target, tagger, message)	Async
Tag.create (repo, tag_name, target, tagger, message, force)	Async
Tag.createLightweight (repo, tag_name, target, force)	Async
Tag.delete (repo, tag_name)	Async
Tag.list (repo)	Async
Tag.listMatch (tag_names, pattern, repo)	Sync
Tag.lookup (repo, id)	Async
Tag.lookupPrefix (repo, id, len)	Async

Instance Methods
Tag#dup ()	Async
Tag#free ()	Sync
Tag#id ()	Sync
Tag#message ()	Sync
Tag#name ()	Sync
Tag#owner ()	Sync
Tag#peel ()	Async
Tag#tagger ()	Sync
Tag#target ()	Sync
Tag#targetId ()	Sync
Tag#targetType ()	Sync

Time

Class Methods
Time.monotonic ()	SyncExperimental

Instance Variables
Time#offset
Time#time

Trace

ENUMS
Trace.LEVEL

TransferProgress

Instance Variables
TransferProgress#indexedDeltas
TransferProgress#indexedObjects
TransferProgress#localObjects
TransferProgress#receivedBytes
TransferProgress#receivedObjects
TransferProgress#totalDeltas
TransferProgress#totalObjects

Transport

Class Methods
Transport.sshWithPaths (owner, payload)	AsyncExperimental
Transport.unregister (prefix)	SyncExperimental

Instance Methods
Transport#init (version)	SyncExperimental
Transport#smartCertificateCheck (cert, valid, hostname)	SyncExperimental

ENUMS
Transport.FLAGS

Tree

Class Methods
Tree.entryCmp (e1, e2)	Sync
Tree.entryDup (dest, source)	Sync
Tree.lookup (repo, id, callback)	Async
Tree.lookupPrefix (repo, id, len)	Async

Instance Methods
Tree#_entryByIndex (idx)	Sync
Tree#_entryByName (filename)	Sync
Tree#builder ()	Sync
Tree#createUpdated (repo, nupdates, updates)	Async
Tree#diff (tree, callback)	Async
Tree#diffWithOptions (tree, options, callback)	Async
Tree#dup ()	Async
Tree#entries ()	Sync
Tree#entryById (id)	Sync
Tree#entryByIndex (i)	Sync
Tree#entryByName (name)	Sync
Tree#entryByPath (path)	Async
Tree#entryCount ()	Sync
Tree#free ()	Sync
Tree#getEntry (filePath)	Async
Tree#id ()	Sync
Tree#owner ()	Sync
Tree#path ()	Sync
[Tree#walk (blobsOnly)	Sync

ENUMS
Tree.UPDATE
Tree.WALK_MODE

TreeEntry

Instance Methods
TreeEntry#filemode ()	Sync
TreeEntry#filemodeRaw ()	Sync
TreeEntry#free ()	Sync
TreeEntry#getBlob ()	Async
TreeEntry#getTree ()	Async
TreeEntry#id ()	Sync
TreeEntry#isBlob ()	Sync
TreeEntry#isDirectory ()	Sync
TreeEntry#isFile ()	Sync
TreeEntry#isSubmodule ()	Sync
TreeEntry#isTree ()	Sync
TreeEntry#name ()	Sync
TreeEntry#oid ()	Sync
TreeEntry#path ()	Sync
TreeEntry#sha ()	Sync
TreeEntry#toObject (repo)	Async
TreeEntry#toString ()	Sync
TreeEntry#type ()	Sync

ENUMS
TreeEntry.FILEMODE

TreeUpdate

Instance Variables
TreeUpdate#action
TreeUpdate#filemode
TreeUpdate#id
TreeUpdate#path

Treebuilder

Class Methods
Treebuilder.create (repo, source)	Async

Instance Methods
Treebuilder#clear ()	Sync
Treebuilder#entrycount ()	Sync
Treebuilder#free ()	Sync
Treebuilder#get (filename)	Sync
Treebuilder#insert (filename, id, filemode)	Sync
Treebuilder#remove (filename)	Sync
Treebuilder#write ()	Sync