https://github.com/davidharrigan/sup
Keep your codebase pristine
https://github.com/davidharrigan/sup
cli golang productivity
Last synced: 6 months ago
JSON representation
Keep your codebase pristine
- Host: GitHub
- URL: https://github.com/davidharrigan/sup
- Owner: davidharrigan
- License: apache-2.0
- Created: 2017-06-28T03:05:08.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-03T01:51:06.000Z (about 9 years ago)
- Last Synced: 2024-06-20T11:12:49.567Z (about 2 years ago)
- Topics: cli, golang, productivity
- Language: Go
- Homepage:
- Size: 5.49 MB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sup
`sup` is a command line utility that will show you outstanding TODO items in the specified path.
If the path belongs to a git repository, the result can further be filtered by the author who made the commit, so you can quickly track down your outstanding work.
## Usage
### `sup`
```
sup [command]
Available Commands:
list List outstanding TODO items in current or specified directory
Use "sup [command] --help" for more information about a command.
```
### `sup list`
```
sup list [path] [flags]
Flags:
-e, --email string Override author look up value (default git config --global user.email
-a, --skip-author Skip author lookup
-g, --skip-git Skip current git commit lookup
```
```
$ sup list
Looking up commits by dharrigan118@gmail.com...
> inner/search_test.py 2 results
inner/search_test.py [0] >>> # TODO
inner/search_test.py [2] >>> return "test" # TODO
> simple.txt 1 results
simple.txt [0] >>> TODO hello
Found 3 outstanding TODOs!
```
## Install
```bash
go get github.com/davidharrigan/sup
```
Make sure your $GOPATH bin is in your $PATH:
```bash
export PATH=$PATH:$GOPATH/bin
```