Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dvinciguerra/gitignore-cli

🛑 A ruby cli tool that use gitignore.io to generate your gitignore files
https://github.com/dvinciguerra/gitignore-cli

cli git gitignore gitignore-cli gitignore-generator ruby term-ui

Last synced: 26 days ago
JSON representation

🛑 A ruby cli tool that use gitignore.io to generate your gitignore files

Awesome Lists containing this project

README

        

# 🛑 gitignore-cli

[![Gem Version](https://badge.fury.io/rb/gitignore-cli.svg)](https://badge.fury.io/rb/gitignore-cli)
[![Maintainability](https://api.codeclimate.com/v1/badges/48ed1e9f5ee6d37590f5/maintainability)](https://codeclimate.com/github/dvinciguerra/gitignore-cli/maintainability)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

Provides a simple CLI that uses the fantastic `gitignore.io` tool to generate `.gitignore` files for your project.

[![asciicast](https://asciinema.org/a/299023.svg)](https://asciinema.org/a/299023?autoplay=1&speed=2)

## Installation

You will need to have `ruby >= 2.3`, or running on Docker.

```shellscript
$ gem install gitignore-cli
```

## Usage

You can use the following commands:

#### gitignore list

The command `list` will return all available environments.

**Example:**

```shellscript
$ gitignore list
```

#### gitignore create

Generates the .gitignore output using an interactive term ui.

```shellscript
$ gitignore create
```

#### gitignore generate [environments]

Generates the .gitignore output to stdout using all environments that you choose.

```shellscript
$ gitignore generate ruby vim node > .gitignore
```

## Author

Daniel Vinciguerra

### Special Thanks

* [Joe Blau](https://github.com/joeblau) for [gitignore.io](https://gitignore.io).
* [Tejas Kumar](https://github.com/TejasQ) for the inspiration, [at TejasQ/add-gitignore](https://github.com/TejasQ/add-gitignore)

## License

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