Fast gitignore CLI tool with cached templates
Project description
gitignore CLI
Fast gitignore CLI tool with cached templates
Features
- Extremely fast - no network calls made if the cache has been retrieved with
gi --refresh
. - Templates source, you can also set additional custom templates dir with
-c
or via$GITIGNORE_CLI_TEMPLATE_DIR
.
Installation
First make sure the git
executable is installed and in your $PATH
,
as it is required to retrieve the gitignore templates.
pipx
This is the recommended installation method.
$ pipx install gitignore-cli-tddschn
pip
$ pip install gitignore-cli-tddschn
Usage
You can either invoke gitignore CLI with gi
or gitignore
.
$ gi -h
usage: gi [-h] [-c CUSTOM_TEMPLATES_DIR] [-o FILE] [-r] [-l] [-a] [-w] [TEMPLATES ...]
gitignore CLI
positional arguments:
TEMPLATES A positional argument (default: None)
options:
-h, --help show this help message and exit
-c CUSTOM_TEMPLATES_DIR, --custom-templates-dir CUSTOM_TEMPLATES_DIR
Custom templates dir, gitignore CLI will look for templates named *.gitignore in this dir first. Defaults to the value of
$GITIGNORE_CLI_TEMPLATE_DIR env var (default: /Users/tscp/.cache/gitignore-cli/gitignore-tddschn/templates)
-o FILE, --out FILE Output to file, append if exists, if -a or -w is not specified (default: <_io.TextIOWrapper name='<stdout>' mode='w'
encoding='utf-8'>)
-r, --refresh Refresh gitignore cache (default: False)
-l, --list Lists available gitignore templates (default: False)
-a, --append Append to the .gitignore of current git repository (default: False)
-w, --write Write to the .gitignore of current git repository (overwrite) (default: False)
Develop
$ git clone https://github.com/tddschn/gitignore-cli-tddschn.git
$ cd gitignore-cli-tddschn
$ poetry install
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
Built Distribution
Close
Hashes for gitignore-cli-tddschn-0.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6812e26cb07370b04fc6d8ad6636b1f04674f135ac6196e0ea4b8d3bab791a7a |
|
MD5 | 6adf1484e95efc6f0a455756fdf9d14d |
|
BLAKE2b-256 | ee8894311d20eb3c82f353d621a1f064d6b0dc0500ac33962216c48d54b4f8dd |
Close
Hashes for gitignore_cli_tddschn-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65361a50f305a61766058c67025aef0f782468bec702f9187882271fa852a636 |
|
MD5 | f8957ee946be796a576e705df7b63ec1 |
|
BLAKE2b-256 | 813691c0da6485bd6e3adb4af73a7a4a8281cc612bbcd7a3423c09d2a725cdc4 |