mirror of
https://github.com/onyx-and-iris/exclude.git
synced 2026-03-30 23:19:09 +00:00
add README
This commit is contained in:
parent
3d33857432
commit
9173cbe01b
62
README.md
Normal file
62
README.md
Normal file
@ -0,0 +1,62 @@
|
|||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
# exclude
|
||||||
|
|
||||||
|
Exclude files from local git tracking
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```console
|
||||||
|
go install github.com/onyx-and-iris/exclude@latest
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
|
||||||
|
*flags*
|
||||||
|
|
||||||
|
- --path/-p: Path the exclude file resides in (default is .git/info/)
|
||||||
|
|
||||||
|
*environment variables*
|
||||||
|
|
||||||
|
```bash
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
export EXCLUDE_PATH="./cmd/testdata/"
|
||||||
|
```
|
||||||
|
|
||||||
|
## Commands
|
||||||
|
|
||||||
|
### Add
|
||||||
|
|
||||||
|
usage: *exclude add [pattern-1] [pattern-2]...*
|
||||||
|
|
||||||
|
```console
|
||||||
|
exclude add "*.log", "temp/"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Del
|
||||||
|
|
||||||
|
usage: *exclude del [pattern]*
|
||||||
|
|
||||||
|
```console
|
||||||
|
exclude del "*.log"
|
||||||
|
```
|
||||||
|
|
||||||
|
### List
|
||||||
|
|
||||||
|
```console
|
||||||
|
exclude list
|
||||||
|
```
|
||||||
|
|
||||||
|
### Reset
|
||||||
|
|
||||||
|
```console
|
||||||
|
exclude reset
|
||||||
|
```
|
||||||
|
|
||||||
|
## Special Thanks
|
||||||
|
|
||||||
|
- [spf13](https://github.com/spf13) for the [cobra](https://github.com/spf13/cobra) and [viper](https://github.com/spf13/viper) packages.
|
||||||
|
- The developers at [charmbracelet](https://github.com/charmbracelet) for the [fang](https://github.com/charmbracelet/fang) package.
|
||||||
Loading…
x
Reference in New Issue
Block a user