Library for using Git in Ruby.
Git public hosting of the project source code is at:
http://github.com/schacon/ruby-git
You can install Ruby/Git like this:
$ sudo gem install git
Git::Base - The object returned from a Git.open or Git.clone. Most major actions are called from this object.
Git::Object - The base object for your tree, blob and commit objects, returned from @git.gtree or @git.object calls. the Git::AbstractObject will have most of the calls in common for all those objects.
Git::Diff - returns from a @git.diff command. It is an Enumerable that returns Git::Diff:DiffFile objects from which you can get per file patches and insertion/deletion statistics. You can also get total statistics from the Git::Diff object directly.
Git::Status - returns from a @git.status command. It is an Enumerable that returns
Git:Status::StatusFile objects for each object in git, which includes files in the working
directory, in the index and in the repository. Similar to running 'git status' on the command line to determine untracked and changed files.
Git::Branches - Enumerable object that holds Git::Branch objects. You can call .local or .remote on it to filter to just your local or remote branches.
Git::Remote- A reference to a remote repository that is tracked by this repository.
Git::Log - An Enumerable object that references all the Git::Object::Commit objects that encompass your log query, which can be constructed through methods on the Git::Log object,
like:
@git.log(20).object("some_file").since("2 weeks ago").between('v2.6', 'v2.7').each { |commit| [block] }
Here are a bunch of examples of how to use the Ruby/Git package.
Ruby < 1.9 will require rubygems to be loaded.
require'rubygems'Require the 'git' gem.
require'git'Git env config
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'endHere are the operations that need read permission only.
g=Git.open(working_dir,:log=>Logger.new(STDOUT))g.indexg.index.readable?g.index.writable?g.repog.dirg.log# returns array of Git::Commit objectsg.log.since('2 weeks ago')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.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.config('user.name')# returns 'Scott Chacon'g.config# returns whole config hashg.tags# returns array of Git::Tag objectsg.show()g.show('HEAD')g.show('v2.8','README.md')Git.ls_remote('https://github.com/schacon/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('.')And here are the operations that will need to write to your git repository.
g=Git.initGit.init('project')Git.init('/home/schacon/proj',{:repository=>'/opt/git/proj.git',:index=>'/tmp/index'})g=Git.clone(URI,NAME,:path=>'/tmp/checkout')g.config('user.name','Scott Chacon')g.config('user.email','email@email.com')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')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.checkout('new_branch')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('origin/remote_branch')g.merge(g.branch('master'))g.merge([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.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'))Some examples of more low-level index and tree operations
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 indexendlicensed under MIT License Copyright (c) 2008 Scott Chacon. See LICENSE for further details.