Project

ignore-it

0.0
The project is in a healthy, maintained state
Feel it's sometimes cumbersome to browse to a website, only to download a .gitignore? We've got your back! ignore-it is a small cli tool, which helps in fetching and creating .gitignore files from gitignore.io or local custom templates. We try to keep runtime dependencies as small as possible and are using mostly standard ruby libraries.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Project Readme

ignore-it

Description

ignore-it is a tool written in ruby which helps in fetching and creating .gitignore files. Currently .gitignore files will be fetched from https://gitignore.io or from local user-made templates.

Installation

gem install ignore-it

Usage

Commands:
  ignore-it add [templateName]  # Select gitignore template to create a .gitignore file or add a template to an existing .gitignore file
  ignore-it help [COMMAND]      # Describe available commands or one specific command
  ignore-it list                # Show List of available .gitignore entries
  ignore-it own [fileName]      # Select user-created template from the folder specified in ~/.ignore-it/config.yml. Default is ~/.ignore-it/gitignores/.

Options:
  [--force]          
  [--output="OUTPUT"]           # Optional Path to directory where .gitignore should be created. 

You can chain multiple gitignores (e.g vsocde and csharp) in a single command with ignore-it add vscode csharp.

Own gitignore templates can be accessed with ignore-it own <fileName>. Per default, the templates need to be created in ~/.ignore-it/gitignores/ and can be named freely. To choose a different path for your own created gitignores, you need to specify the absolute path to the directory in ~/ignore-it/config.yml

Configuration

Configuration can be done in ~/.ignore-it/config.yml.

Development

  1. Clone the repo
  2. install Dependencies with bundle install
  3. Run with bundle exec ignore-it
  4. Optionally Build with gem build ignore_it.gemspec
  5. Optionally Install locally with gem install ignore-it-[VERSION].gem