gignore

A simple and lightweight CLI for generating .gitignore files from gitignore.io templates.

Instead of manually searching for .gitignore templates, just tell gignore which technologies or tools your project uses.

Installation

Install globally with pipx:

pipx install gignore-cli

You can also install it with pip:

pip install gignore-cli

Usage

Generate a .gitignore for a Python project:

gignore python

You can combine multiple templates by separating them with commas:

gignore python,node

For example, for a project using Python, Node.js and VS Code:

gignore python,node,vscode

The generated .gitignore is created in the current working directory.

Adding templates

If a .gitignore already exists, gignore will ask whether you want to add the generated rules to the existing file.

For example:

gignore python,node

You can confirm the operation interactively, and the new rules will be added to the existing .gitignore.

Overwriting an existing file

To overwrite an existing .gitignore without confirmation, use -o or --override:

gignore python --override

or:

gignore python -o

List available templates

Display all available templates:

gignore --list

or:

gignore -l

Find templates

Search for templates by name:

gignore --find python

or:

gignore -f python

You can use this to discover the correct template name before generating your .gitignore.

Help

Display the available options and examples:

gignore --help

or:

gignore -h

Examples

Python project

mkdir my-project
cd my-project

gignore python

Full-stack project

gignore python,node,vscode

Multiple environments

gignore python,windows,macos,linux

Find a template

gignore -f django

List all templates

gignore -l

Overwrite an existing .gitignore

gignore python,node -o

How it works

gignore sends the requested templates to gitignore.io and uses the returned content to create or update the .gitignore file.

For example:

gignore python,node

requests the python and node templates and combines their rules into the generated .gitignore.

If a .gitignore already exists, the generated rules can be added to the existing file. Use --override when you want to replace the existing file instead.

Features

• Simple command-line interface
• Supports multiple templates
• Search for available templates
• List all available templates
• Add generated rules to an existing .gitignore
• Optional overwrite with --override
• Generates .gitignore in the current directory
• Built-in --help
• Clear terminal output using Rich
• Uses gitignore.io templates
• Lightweight and easy to use

Development

Clone the repository:

git clone https://github.com/ze-fernando/gignore.git
cd gignore

Install the development dependencies:

pdm install

Run the CLI locally:

pdm run python -m gignore.main python,node

Build the package:

pdm build

The generated packages will be available in the dist/ directory.

License

This project is licensed under the MIT License.