mkGitignore - Easy create a ".gitignore" in the current directory

mkGitignore is a GPLv3 tool to use the https://www.gitignore.io API from the cli

This is not an official tool from gitignore.io

How to use

Run mkgitignore --keywords vim,ruby in your terminal to create a .gitignore file setup for vim and ruby.

Run mkgitignore --help to get some help. To read more informations, run man mkgitignore.

How to install

Requirements:

• GNU Bash
• curl
• GNU troff (groff)

1. Run curl -sSL https://raw.githubusercontent.com/sfeuga/mkgitignore/master/install.sh | bash.
2. Open a new shell or source your source ~/.bashrc or source ~/.zshrc according to your shell and enjoy.
3. Optional: To install the cheat file run curl -sFLo $HOME/.cheat/mkgitignore --create-dirs https://raw.githubusercontent.com/sfeuga/mkgitignore/master/mkgitignore.cheat.

You can also setup a git alias to create a default .gitignore with git config --global alias.mkg '!mkgitignore -d' and then type git mkg to generate your default .gitignore or type git mkg -k ruby to use "default" and "ruby" keywords.

Run mkgitignore --display-default to see which default values are set and see man mkgitignore to create a .mkgitignorerc file to override default values.

Reporting bugs

Tested on Fedora with GNU/Bash 5.0.7(1) and Zsh 5.7.1

Please use the GitHub issue tracker for any bugs or feature suggestions:

https://github.com/sfeuga/mkgitignore/issues

TODO

• Add automated test (bats ?)
• Add an option to create a .mkgitignorerc. Ex: mkgitignore -E -k vim,ruby,linux will run echo "keywords='vim,ruby,linux'" > ~/.mkgitignorerc

Contributing

If you use it under other OS or shell version, please let me know and I will update this README.md or even better, Update the README.md by yourself.

Please submit patches to code or documentation as GitHub pull requests!

Contributions must be licensed under the GNU GPLv3. The contributor retains the copyright.

Copyright

mkgitignore is licensed under the GNU General Public License, v3. A copy of this license is included in the file COPYING This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. Copyright (C) 2019 Stephane FEUGA OSHIMA sfeuga@member.fsf.org."