generate-gitignore 1.0.2

A CLI tool for generating .gitignore files

Generate Gitignore

A simple Python script to generate a .gitignore file for your project using the templates from github.com/github/gitignore

Templates

Templates are taken from the github.com/github/gitignore repository and are updated every 24 hours.

The parsed list of templates can be found in the templates.json file. This file is used by the script to generate the list of available templates.

I am not a maintainer of the gitignore source repository, so if you wish to have a template added, please open an issue or a pull request on the source repository as I do not maintain any custom templates.

Usage

Installation

Install the package using pip:

pip install generate-gitignore

For global installation, it is recommended to use pipx as to avoid breaking any system packages, especially on linux systems:

pipx install generate-gitignore

Running

Once installed, you can run the script with the following command:

generate-gitignore

Listing all available templates

You can list all available templates with the list command:

generate-gitignore list

Searching for a template

You can search for a template with the search command, it will launch an interactive search in the terminal allowing you to search by name and apply the selected template:

generate-gitignore search

Generating a .gitignore file

If you want to use a template directly, you can use the use command followed by an array of template names:

generate-gitignore use python visualstudiocode ...

Contributing

Contributions are welcome, please open an issue or a pull request if you wish to contribute. Make sure to follow the Contribution Guidelines before submitting a pull request.