dominhhai / gitignore

Create `.gitignore` file from any source

giig

Create .gitignore file from any source such as Github or your local directory.

Installation

$ npm i -g giig

Usage

1. Fetch template

Fetch tpl .gitignore template from registered source:

$ giig fetch [options] <tpl>

Options:

• -s, --source [source]: source name (default: github)
• -d, --dest [dest]: project root (default: .gitignore)
• -h, --help: output usage information

The source must be registered before using. Except the github is always available. See here for more info.

E.x: Download the Node template from github

$ giig fetch Node

2. List templates

List all available .gitignore templates from src source (default: github):

$ giig list [src]

E.x: Show all templates from github

$ giig list github

3. List template sources

List all available sources:

$ giig src-list

4. Add/Update source information

Add/Update key source info with list and file:

$ giig src-add <key> <list> [file]

Where:

• list: URL or Directory which contain list of templates. If list is a url, it has to return a json file as Github Contents API.
• file: The root path contains template file. Default is the value of list.

E.x 1: Add template source from ~/gitignore_tpl folder with name igiig

$ giig src-add igiig "~/gitignore_tpl"

E.x 2: Add template source from https://github.com/dvcs/gitignore with name dvcs

$ giig src-add dvcs "https://api.github.com/repos/dvcs/gitignore/contents/templates" "https://raw.githubusercontent.com/dvcs/gitignore/master/templates"

5. Show source information

Show key source info:

$ giig src-show <key>

E.x: Show dvcs source info

$ giig src-show dvcs

6. Remove source information

Remove key source from source list:

$ giig src-del <key>

E.x: Remove dvcs source

$ giig src-del dvcs