GI Gen - Gitignore File Generator
Table of Contents
GI Gen is an open source CLI to generate .gitignore
files. It is completely cross-platform, and
standalone (no dependencies - other than git
itself), so you may literally use it for any project
on any platform.
You can run this CLI program to create or append a .gitignore
file from a chosen list of template
easily.
You may choose more than one template to generate.
Command Line Usage
Download the file for your platform in the Releases page.
Put it anywhere that you can run an executable from. It is completely portable to any directory, but
it is preferable you put it somewhere that is in your PATH
.
Just run gi_gen
in the directory you wish to add to and follow the prompts.
$ gi_gen
Command Line Flags
You may pass additional flags to gi_gen
. These are the currently available flags:
Usage |
Description |
-clean-cache |
Allows you to remove the contents of the gitignore template cache |
-help |
Prints usage information |
Features
GI Gen supports the following features:
.gitignore
discovery:
- Auto-discover any gitignore templates that might be related to your project
- Optionally list all available templates instead (see github/gitignore for the complete
list of templates)
.gitignore
clean: Clean up results from any patterns that aren't in your project before
outputting (optional)
- Writes to
.gitignore
file in current directory (you may overwrite/skip/append if already exists)
Credits to open-source-ideas for the idea for the tool.
Contribute
Please feel free to open PRs or issues with bug fixes/reports, or feature requests.
This project was built using Go, and should run easily with the normal Go tools with no further
configuration.
Testing was only done on Windows x386 and macOS ARM, so feel free to report any issues on your
platform if you have any, or are missing your platform and cannot/don't want to build from source (I
tried building for the most common platforms).
If you are feeling incredibly generous and appreciate the time & effort I put into developing
this tool, kindly consider donating any amount to help me make up for the work hours. It is really
very much appreciated! 🙏🏼