mirror of
https://github.com/onyx-and-iris/ignr.git
synced 2025-07-27 06:11:48 +00:00
onyx-and-iris
70b1c373ae
- it gives more control over filtering add --filter/-f flag, this allows configuration over a prefix vs contains filter update the README to reflect changes
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
|
|
|
|
|
|
|
|
# ignr-cli
|
|
|
|
Simple no-frills .gitignore generator backed by the Github API.
|
|
|
|
|
|
|
|
## Install
|
|
|
|
```console
|
|
go install github.com/onyx-and-iris/ignr-cli@latest
|
|
```
|
|
|
|
## Configuration
|
|
|
|
*flags*
|
|
|
|
- --token/-t: GitHub authentication token
|
|
- note, this tool can be used **without** authenticating but rate limiting will be stricter.
|
|
- --height/-H: Height of the selection prompt (default 20)
|
|
- --filter/-f: Type of filter to apply to the list of templates (default startswith)
|
|
- may be one of (startswith, contains)
|
|
|
|
*environment variables*
|
|
|
|
```bash
|
|
#!/usr/bin/env bash
|
|
|
|
export IGNR_TOKEN=<API Token>
|
|
export IGNR_HEIGHT=20
|
|
export IGNR_FILTER=startswith
|
|
```
|
|
|
|
## Commands
|
|
|
|
### New
|
|
|
|
Trigger the selection prompt.
|
|
|
|
```console
|
|
ignr-cli new
|
|
```
|
|
|
|
The prompt filter can be activated by pressing `/`:
|
|
|
|
|
|
|
|
## Special Thanks
|
|
|
|
- [Charm](https://github.com/charmbracelet) for their awesome CLI packages.
|