https://github.com/robwillup/qwest
A CLI to-do app that documents features and tasks directly in the source code.
https://github.com/robwillup/qwest
Last synced: about 1 year ago
JSON representation
A CLI to-do app that documents features and tasks directly in the source code.
- Host: GitHub
- URL: https://github.com/robwillup/qwest
- Owner: robwillup
- License: mit
- Created: 2020-07-19T14:04:24.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2021-02-26T02:24:29.000Z (over 5 years ago)
- Last Synced: 2023-04-20T21:35:30.007Z (about 3 years ago)
- Language: C#
- Homepage:
- Size: 427 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quest - Work Management for Devs
`Quest` is a CLI app for creating *tasks* straight from the command line. The tasks are saved to a Markdown file in the project's source code. This helps developers manage their work directly from their source code files. Also, the completed tasks show the project's history and evolution.
## How does it work?
### View commands and options:
```
$ quest help
Quest!
COMMANDS:
do.............Creates a new task
done...........Lists completed tasks
done ....Marks the task as complete
todo...........Lists current active tasks
undo...........Marks a complete task as active
dont...........Deletes a task from ToDos
config.........View and edit Quest settings
version........Displays current version
help...........Displays information about commands and flags
Use 'quest help ' for more information.
```
### Create a new task:
```bash
$ quest do "write new unit test for function XYZ" --app "my-app" --feature "new-feature"
```
### List active tasks:
```bash
$ quest todo
# To Dos
* write new unit test - (2b2f3c4d-3e06-4465-88a3-6155a983583f) - Created at: 12/31/2020 12:00:02 PM
```
### Complete a task:
```bassh
$ quest done 2b2f --app my-app --feature my-feature
```
### List completed tasks:
```bash
$ quest done
* write new unit test - (2b2f3c4d-3e06-4465-88a3-6155a983583f) - Created at: 12/31/2020 12:00:02 PM - Completed at: 12/31/2020 12:01:59 PM
```
### Move a completed task back to active
```bash
$ quest undo 2b2f --app my-app --feature my-feature
```
### Delete an active task:
```bash
$ quest dont 2b2f --app my-app --feature my-feature
```
### View settings
```bash
$ quest config list
```
### Add configuration section
```bash
$ quest config add --name "my-app" --local-path "src/app" --remote "github.com/username/repo"
```
### Remove configuration section
```bash
$ quest config rm --name "my-app"
```
## How to Install
Download the latest version from [here](https://github.com/robwillup/quest/releases/tag/v0.0.2).
## Contributing
Contributions are very welcome!
Feel free to start a [discussion](https://github.com/robwillup/quest/discussions), open an [issue](https://github.com/robwillup/quest/issues) or open a [PR](https://github.com/robwillup/quest/pulls).
## License
Quest is licensed under the terms of the MIT license.