# journal_cli
A simple command line tool for writing small journal entries for your projects.


## Usage
The tool is used for writing journal entries or notes for your project.

For adding a entry or note, write this into your command line
```bash
journal_cli -m "foo bar"
```


For deleting the log file, use the following command
```bash
journal_cli --empty
```

If you have you used a custom path for writing your entries or notes, use the following command
```bash
journal_cli --empty --path "YOUR PATH"  
```

Here are all the possible flags and options for journal_cli
```text
USAGE:
    journal_cli [FLAGS] [OPTIONS]

FLAGS:
    -e, --empty       Option to empty the log file. If you used a custom path you need to also pass this as an argument.
    -h, --help        Prints help information
    -n, --noheader    Option to write to the file without a header
    -V, --version     Prints version information

OPTIONS:
    -m, --message <message>    The log message [default: ]
    -p, --path <path>          The path where the message will be saved [default: ./log.txt]
```

The numbering breaks if you create more than 99 log entries. This will be fixed in future versions
## Install
Requires that you have [Rust 2018](https://www.rust-lang.org/tools/install) installed. Journal_cli is published to [crates.io](crates.io) and can be installed with the following command.
```bash
cargo install journal_cli
```
## Update
Because journal_cli is installed through crates.io you have to reinstall the package to update it.
```bash
cargo install journal_cli --force
```