Homepage

Documentation

Install

sudo gem install git

Code Status

Major Objects

Examples

require'rubygems'

require'git'

Git.configuredo |config|# If you want to use a custom git binaryconfig.binary_path='/git/bin/path'# If you need to use a custom SSH scriptconfig.git_ssh='/path/to/ssh/script'end

g=Git.open(working_dir,:log=>Logger.new(STDOUT))g.indexg.index.readable?g.index.writable?g.repog.dir# log - returns a Git::Log object, which is an Enumerator of Git::Commit objects# default configuration returns a max of 30 commitsg.logg.log(200)# 200 most recent commitsg.log.since('2 weeks ago')# default count of commits since 2 weeks ago.g.log(200).since('2 weeks ago')# commits since 2 weeks ago, limited to 200.g.log.between('v2.5','v2.6')g.log.each{|l|putsl.sha}g.gblob('v2.5:Makefile').log.since('2 weeks ago')g.object('HEAD^').to_s# git show / git rev-parseg.object('HEAD^').contentsg.object('v2.5:Makefile').sizeg.object('v2.5:Makefile').shag.gtree(treeish)g.gblob(treeish)g.gcommit(treeish)commit=g.gcommit('1cc8667014381')commit.gtreecommit.parent.shacommit.parents.sizecommit.author.namecommit.author.emailcommit.author.date.strftime("%m-%d-%y")commit.committer.namecommit.date.strftime("%m-%d-%y")commit.messagetree=g.gtree("HEAD^{tree}")tree.blobstree.subtreestree.children# blobs and subtreesg.revparse('v2.5:Makefile')g.branches# returns Git::Branch objectsg.branches.localg.current_branchg.branches.remoteg.branches[:master].gcommitg.branches['origin/master'].gcommitg.grep('hello')# implies HEADg.blob('v2.5:Makefile').grep('hello')g.tag('v2.5').grep('hello','docs/')g.describe()g.describe('0djf2aa')g.describe('HEAD',{:all=>true,:tags=>true})g.diff(commit1,commit2).sizeg.diff(commit1,commit2).statsg.diff(commit1,commit2).name_statusg.gtree('v2.5').diff('v2.6').insertionsg.diff('gitsearch1','v2.5').path('lib/')g.diff('gitsearch1',@git.gtree('v2.5'))g.diff('gitsearch1','v2.5').path('docs/').patchg.gtree('v2.5').diff('v2.6').patchg.gtree('v2.5').diff('v2.6').eachdo |file_diff|putsfile_diff.pathputsfile_diff.patchputsfile_diff.blob(:src).contentsendg.worktrees# returns Git::Worktree objectsg.worktrees.countg.worktrees.eachdo |worktree|worktree.dirworktree.gcommitworktree.to_sendg.config('user.name')# returns 'Scott Chacon'g.config# returns whole config hash# Configuration can be set when cloning using the :config option.# This option can be an single configuration String or an Array# if multiple config items need to be set.#g=Git.clone(git_uri,destination_path,:config=>['core.sshCommand=ssh -i /home/user/.ssh/id_rsa','submodule.recurse=true'])g.tags# returns array of Git::Tag objectsg.show()g.show('HEAD')g.show('v2.8','README.md')Git.ls_remote('https://github.com/ruby-git/ruby-git.git')# returns a hash containing the available references of the repo.Git.ls_remote('/path/to/local/repo')Git.ls_remote()# same as Git.ls_remote('.')Git.default_branch('https://github.com/ruby-git/ruby-git')#=> 'master'

g=Git.initGit.init('project')Git.init('/home/schacon/proj',{:repository=>'/opt/git/proj.git',:index=>'/tmp/index'})# Clone from a git urlgit_url='https://github.com/ruby-git/ruby-git.git'# Clone into the ruby-git directoryg=Git.clone(git_url)# Clone into /tmp/clone/ruby-git-cleanname='ruby-git-clean'path='/tmp/clone'g=Git.clone(git_url,name,:path=>path)g.dir#=> /tmp/clone/ruby-git-cleang.config('user.name','Scott Chacon')g.config('user.email','email@email.com')# Clone can take a filter to tell the serve to send a partial cloneg=Git.clone(git_url,name,:path=>path,:filter=>'tree:0')# Clone can take an optional loggerlogger=Logger.newg=Git.clone(git_url,NAME,:log=>logger)g.add# git add -- "."g.add(:all=>true)# git add --all -- "."g.add('file_path')# git add -- "file_path"g.add(['file_path_1','file_path_2'])# git add -- "file_path_1" "file_path_2"g.remove()# git rm -f -- "."g.remove('file.txt')# git rm -f -- "file.txt"g.remove(['file.txt','file2.txt'])# git rm -f -- "file.txt" "file2.txt"g.remove('file.txt',:recursive=>true)# git rm -f -r -- "file.txt"g.remove('file.txt',:cached=>true)# git rm -f --cached -- "file.txt"g.commit('message')g.commit_all('message')# Sign a commit using the gpg key configured in the user.signingkey config settingg.config('user.signingkey','0A46826A')g.commit('message',gpg_sign:true)# Sign a commit using a specified gpg keykey_id='0A46826A'g.commit('message',gpg_sign:key_id)# Skip signing a commit (overriding any global gpgsign setting)g.commit('message',no_gpg_sign:true)g=Git.clone(repo,'myrepo')g.chdirdonew_file('test-file','blahblahblah')g.status.changed.eachdo |file|putsfile.blob(:index).contentsendendg.reset# defaults to HEADg.reset_hard(Git::Commit)g.branch('new_branch')# creates new or fetches existingg.branch('new_branch').checkoutg.branch('new_branch').deleteg.branch('existing_branch').checkoutg.branch('master').contains?('existing_branch')# delete remote branchg.push('origin','remote_branch_name',force:true,delete:true)g.checkout('new_branch')g.checkout('new_branch',new_branch:true,start_point:'master')g.checkout(g.branch('new_branch'))g.branch(name).merge(branch2)g.branch(branch2).merge# merges HEAD with branch2g.branch(name).in_branch(message){# add files }  # auto-commitsg.merge('new_branch')g.merge('new_branch','merge commit message',no_ff:true)g.merge('origin/remote_branch')g.merge(g.branch('master'))g.merge([branch1,branch2])g.merge_base('branch1','branch2')r=g.add_remote(name,uri)# Git::Remoter=g.add_remote(name,Git::Base)# Git::Remoteg.remotes# array of Git::Remotesg.remote(name).fetchg.remote(name).removeg.remote(name).mergeg.remote(name).merge(branch)g.fetchg.fetch(g.remotes.first)g.fetch('origin',{:ref=>'some/ref/head'})g.fetch(all:true,force:true,depth:2)g.fetch('origin',{:'update-head-ok'=>true})g.pullg.pull(Git::Repo,Git::Branch)# fetch and a mergeg.add_tag('tag_name')# returns Git::Tagg.add_tag('tag_name','object_reference')g.add_tag('tag_name','object_reference',{:options=>'here'})g.add_tag('tag_name',{:options=>'here'})Options::a |:annotate:d:f:m |:message:sg.delete_tag('tag_name')g.repackg.pushg.push(g.remote('name'))# delete remote branchg.push('origin','remote_branch_name',force:true,delete:true)# push all branches to remote at one timeg.push('origin',all:true)g.worktree('/tmp/new_worktree').addg.worktree('/tmp/new_worktree','branch1').addg.worktree('/tmp/new_worktree').removeg.worktrees.prune

g.with_temp_indexdog.read_tree(tree3)# calls self.index.read_treeg.read_tree(tree1,:prefix=>'hi/')c=g.commit_tree('message')# or #t=g.write_treec=g.commit_tree(t,:message=>'message',:parents=>[sha1,sha2])g.branch('branch_name').update_ref(c)g.update_ref(branch,c)g.with_temp_workingdo# new blank working directoryg.checkoutg.checkout(another_index)g.commit# commits to temp_indexendendg.set_index('/path/to/index')g.with_index(path)do# calls set_index, then switches back afterendg.with_working(dir)do# calls set_working, then switches back afterendg.with_temp_working(dir)dog.checkout_index(:prefix=>dir,:path_limiter=>path)# do file workg.commit# commits to indexend

License