https://github.com/kjbrum/stndp
A command line tool for doing daily stand-ups.
https://github.com/kjbrum/stndp
Last synced: 21 days ago
JSON representation
A command line tool for doing daily stand-ups.
- Host: GitHub
- URL: https://github.com/kjbrum/stndp
- Owner: kjbrum
- License: mit
- Created: 2016-01-08T22:26:44.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-14T00:26:29.000Z (over 9 years ago)
- Last Synced: 2025-02-12T07:55:20.354Z (2 months ago)
- Language: Shell
- Size: 26.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# stndp
> A command line tool for doing daily stand-ups.
## Install
__Dependencies:__
- [jq](https://stedolan.github.io/jq) - Used to parse the JSON responses.
```
$ curl https://raw.githubusercontent.com/kjbrum/stndp/master/stndp > ~/bin/stndp
$ chmod +x ~/bin/stndp
```
## Usage
```
stndp - v0.0.1
A command line tool for doing daily stand-ups.
Usage:
stndp
Commands:
add Add a new record to the database
users
questions
answers
cleanup Remove all config files
help Display this help text
init Initialize necessary config files
list List records from the database
users
questions
answers
start Start the daily stand-up prompts
status List your teams responses for the current day
latest Download the latest version of stndp
version Display the current version
```
## Config
#### STNDP_API_KEY
Your Airtable API key. [Find it here](https://airtable.com/account)
#### STNDP_USERNAME
Your team username.
## To-Do
- ~~Add a `start` command~~
- Ask the user if they want to re-answer the questions if the command is ran multiple times in the same day
- ~~Add a `status` command that lists all the teams answers for the day~~
- Handle returning an empty object (if nobody has update their status for the day yet)
- Options:
- `--username`
- `--date`
- Add an `update` command for updating records
- Add a `remove` command for deleting records
- Add a `slack-it` command to post the status' to a Slack channel
- Figure out how to handle `'` in answers
- Add autocompletion for commands
- Add database/table schema so others can use the code
## License
Copyright © [Kyle Brumm](http://kylebrumm.com). Free to use on whatever and may be redistributed under the terms specified in the [license](LICENSE.md).