/gitcopy

Download the contents of a github repo without cloning it.

Primary LanguageRubyMIT LicenseMIT

Gitcopy

Gitcopy will download the contents of a github repository to your current folder without producing a local clone of the repository.

Installation

Add this line to your application's Gemfile:

gem 'gitcopy'

And then execute:

$ bundle

Or install it yourself as:

$ gem install gitcopy

Usage

Use from the command line by running:

$ gitcopy GITHUB_REPO_URL DESTINATION_PATH

Or from another ruby file by calling:

GitCopy::copyRepo(GITHUB_REPO_URL, DESTINATION_PATH)

Note that if no DESTINATION_PATH is set, it will default to the current directory.

Development

After checking out the repo, run bin/setup to install dependencies. 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/mseijas/gitcopy. 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.