CLI tool aim to clean local git repository from .gitignore file(s)/folder(s).
Project description
Welcome to Gitcln 👋
CLI tool aim to clean local git repository from .gitignore file(s)/folder(s).
you can create or download .gitignore file and use this tool anywhere.
Installation ⚓
$ pip install gitcln
Usage 🗝
Arg | Shortcut | Type | Description | Default |
---|---|---|---|---|
--directories | -d | optional | directory(ies) to ignore | [ ] |
--files | -f | optional | file(s) to ignore | [ ] |
$ gitcln --help
usage: gitcln [-h] [-d [DIRECTORIES [DIRECTORIES ...]]] [-f [FILES [FILES ...]]]
CLI tool aim to clean local git repository from .gitignore file(s)/folder(s).
optional arguments:
-h, --help show this help message and exit
-d [DIRECTORIES [DIRECTORIES ...]], --directories [DIRECTORIES [DIRECTORIES ...]]
Directory(ies) to ignore. (default: [])
-f [FILES [FILES ...]], --files [FILES [FILES ...]]
File(s) to ignore. (default: [])
Examples :
- Remove all .gitignore file(s)/folder(s) :
$ gitcln
- Remove all .gitignore file(s)/folder(s) except specific directory(ies) :
$ gitcln -d __pycache__
- Remove all .gitignore file(s)/folder(s) except specific file(s) :
$ gitcln -f bytes.pyc
Tests 🧪
Only integration tests for gitcln module runs on the CI pipeline.
Roadmap 📈
- Add additional CLI option to skip .gitignore ignores by unique comment.
- Add .gitcln file to ignore file(s) folder(s) from scanning.
- Filter .gitignore by section name.
Copyright ©
👤 Hadi Zaki Alqattan
- Github: @hadizakialqattan
- Email: alqattanhadizaki@gmail.com
📝 License
Copyright © 2020 Hadi Zaki Alqattan.
This project is MIT licensed.
Give a ⭐️ if this project helped you!
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gitcln-20.4.4.tar.gz
(5.7 kB
view hashes)