# todo_cli
This is a simple command line tool for writing a todo list for your project
# Usage
The tool is used for writing todo lists and the available flags and options is the following:
``` console
USAGE:
TODO [FLAGS] [OPTIONS]
FLAGS:
-d, --delete Deletes the TODO file, if you have used a custom path before you also need to pass that
-h, --help Prints help information
-s, --show Prints out the TODO list
-V, --version Prints version information
OPTIONS:
-r, --remove <index> Will delete a TODO item with a specific number [default: ]
-m, --message <message> The TODO item [default: ]
-p, --path <path> Path to the TODO file. It will create the file if it doesn't find it, however it can't
create a folder [default: ./todo.txt]
```
If you want to add an item to your todo list, use the following command:
``` console
todo_cli --message "TODO ITEM"
```
# Installation
Because todo_cli is published to [cartes.io](crates.io) you need to have [Rust](https://www.rust-lang.org/tools/install) installed on your system to install the package.
``` console
cargo install todo_cli
```
# Update
Currently the only way to update todo_cli is by reinstalling it, which is done using the following command.
``` console
cargo install todo_cli--force
```