|
| 1 | + |
| 2 | +# Tusker |
| 3 | +A dead simple todo manager in *less than 100 lines* of Bash. |
| 4 | +For those who live in the terminal. |
| 5 | + |
| 6 | +### Installation |
| 7 | +Just download the executable from [releases](https://github.com/coderick14/tusker/releases) and put it in your `$PATH`. Period. |
| 8 | +Type `tusker help` to get started. |
| 9 | + |
| 10 | +### Usage |
| 11 | +- Add a task |
| 12 | +``` |
| 13 | +tusker add "The task that I would've forgotten" |
| 14 | +``` |
| 15 | +- Show current tasks *[ID, Status, Description, CreatedAt]* |
| 16 | +``` |
| 17 | +tusker show |
| 18 | + 1 ❌ Collect laundry 25 April 2018 11:53:21 |
| 19 | + 2 ❌ Collect NOC certificate 25 April 2018 11:53:23 |
| 20 | + 3 ❌ Fill rems 25 April 2018 11:53:25 |
| 21 | +``` |
| 22 | +- Mark a task as done |
| 23 | +``` |
| 24 | +tusker check 1 |
| 25 | +tusker show |
| 26 | + 1 ✓ Collect laundry 25 April 2018 11:53:21 |
| 27 | + 2 ❌ Collect NOC certificate 25 April 2018 11:53:23 |
| 28 | + 3 ❌ Fill rems 25 April 2018 11:53:25 |
| 29 | +``` |
| 30 | +- Mark a task as undone |
| 31 | +``` |
| 32 | +tusker uncheck 1 |
| 33 | +tusker show |
| 34 | + 1 ❌ Collect laundry 25 April 2018 11:53:21 |
| 35 | + 2 ❌ Collect NOC certificate 25 April 2018 11:53:23 |
| 36 | + 3 ❌ Fill rems 25 April 2018 11:53:25 |
| 37 | +``` |
| 38 | +- Delete a task from the list |
| 39 | +``` |
| 40 | +tusker del 2 |
| 41 | +tusker show |
| 42 | + 1 ❌ Collect laundry 25 April 2018 11:53:21 |
| 43 | + 2 ❌ Fill rems 25 April 2018 11:53:25 |
| 44 | +``` |
| 45 | + |
| 46 | +### What's the difference between `check` and `del`? |
| 47 | +Use `del` if you'd *never* like to look back at a completed task. |
| 48 | +Use `check` if you want the satisfaction of seeing the ✓ beside your completed task for a while. |
| 49 | +Also, you can `uncheck` it anytime, in case you missed out on something :( |
| 50 | + |
| 51 | +### Tip |
| 52 | +Add `tusker show` at the end of your `.bashrc`, `.zshrc` or `config.fish` to get reminded about your pending tasks whenever you fire up a terminal. |
| 53 | + |
| 54 | +### Why tusker? |
| 55 | +- No dependencies. Seriously. |
| 56 | +- Simple. So that you can focus on what's important, which is **finishing your tasks**. |
| 57 | + |
| 58 | +### Features and contributions |
| 59 | +`tusker` was written a couple of nights before my semester examination because I kept forgetting the topics that I had skipped. So if you find a bug or you'd like to add a feature, feel free to raise an issue or send a pull request!! |
0 commit comments