mirror of
https://github.com/onyx-and-iris/ignr.git
synced 2025-07-27 06:11:48 +00:00
52 lines
1.1 KiB
Markdown
52 lines
1.1 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
|
|
```
|
|
|
|
## Authentication
|
|
|
|
You can run this tool without authenticating but requests will have a stricter rate limiting.
|
|
|
|
If you prefer to authenticate you can pass a token in the following ways:
|
|
|
|
*Flag*
|
|
|
|
- --token/-t: Github API Token
|
|
|
|
*Environment Variable*
|
|
|
|
```bash
|
|
#!/usr/bin/env bash
|
|
|
|
export GH_TOKEN=<API Token>
|
|
```
|
|
|
|
## Commands
|
|
|
|
### New
|
|
|
|
Trigger the selection prompt.
|
|
|
|
```console
|
|
ignr-cli new
|
|
```
|
|
|
|
The prompt filter can activated by pressing `/`:
|
|
|
|

|
|
|
|
## Special Thanks
|
|
|
|
- [Charm](https://github.com/charmbracelet) for their awesome CLI packages.
|