BigKeeper/big-stash

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# BigStash

[![Build Status](https://travis-ci.org/BigKeeper/big-stash.svg?branch=master)](https://travis-ci.org/BigKeeper/big-stash)
[![Maintainability](https://api.codeclimate.com/v1/badges/5f0f2238df6d7f3908bf/maintainability)](https://codeclimate.com/github/BigKeeper/big-stash/maintainability)
[![Gem Version](https://badge.fury.io/rb/big_stash.svg)](https://rubygems.org/gems/big_stash)
[![Language: Ruby](https://img.shields.io/badge/language-Ruby-da212f.svg)](https://www.ruby-lang.org/)
[![License](https://img.shields.io/badge/license-MIT-000000.svg)](https://github.com/BigKeeper/big-stash/blob/master/LICENSE)
[![Gitter](https://img.shields.io/gitter/room/BigKeeper/BigKeeper.svg)](https://gitter.im/Big-Keeper/Lobby)

big-stash is an enhancement for `git stash` command, you can use it to add and apply a stash with the name you have specified before.

## Preview

![](https://github.com/BigKeeper/big-stash/blob/master/resources/demo.png)

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'big_stash'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install big_stash

## Usage

Run `big-stash` to learn how to use big-stash.

### Add a stash with name

If you want to add a stash for a git repository, run following command:

``` ruby
big-stash -p [root path for a git repository] add [name of the stash]
```

### Pop a stash with name

If you want to apply then delete a stash for a git repository, run following command:

``` ruby
big-stash -p [root path for a git repository] pop [name of the stash]
```

### Apply a stash with name

If you want to apply a stash for a git repository, run following command:

``` ruby
big-stash -p [root path for a git repository] apply [name of the stash]
```

### List all the stashes

If you want to list all the stashes for a git repository, run following command:

``` ruby
big-stash -p [root path for a git repository] list
```

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/BigKeeper/big-stash.

## License

![](https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/License_icon-mit-88x31-2.svg/128px-License_icon-mit-88x31-2.svg.png)

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).