Skip to content

acant/git_simple

Repository files navigation

GitSimple

Gem Version Code Climate Build Status Inline docs Dependency Status Test Coverage

Git porcelain layer in Ruby, for bare and working repositories. The rugged gem, and libgit2, are used to provide the git plumbing.

Installation

Add this line to your application's Gemfile:

gem 'git_simple'

And then execute:

$ bundle

Or install it yourself as:

$ gem install git_simple

Usage

Clone from a remote repository:

GitSimple.clone('git@server:user/repo_name.git')

Or a new commit to the repository:

GitSimple('repo')
  .add('new_file')
  .rm('old_file')
  .commit('Made some changes', name: 'Art T. Fish', email: 'afish@example.com')

Alternative Projects

Alternative gem which provide a Ruby porcelain type git interface exist, and will be listed here:

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/acant/git_simple. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the GitSimple project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Simple git command layer in Ruby.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published