Todo-rs

When working on personal projects, I like to have an overview of the tasks that I still want to finish right alongside my project. Although TODO comments are nice and all, sometimes there are just things that you want to keep as tasks, that concern the whole project. So I found myself writing a lot of todo files that I would leave at the root of the project.

Because I would do this a lot, I wrote a small programm to handle todo lists from the command line. The files should still be human readable.

Todo-rs fills this need for me. It’s written in Rust and was an opportunity for me to learn about the clap argument parsing library.

Usage

To create an empty .todo file in your directory, simply run:

todo create

Once you have a .todo file, you can add entries with:

> todo add "My first todo"
Added: "My first todo"

This will show up as [ ] My first todo in the .todo file so that you can manually edit todos quickly and easily understand changes in a commit diff. Now lets add a second item:

> todo add "My second todo"
Added: "My second todo"
> todo list
1 [ ] My first todo
2 [ ] My second todo

I feel like the usafe becomes pretty self explanatory from here.

> todo check 1
[x] My first todo
> todo list
1 [ ] My second todo

2 [x] My first todo
> todo remove 1
Removed: [ ] My second todo 
> todo list

1 [ ] My first todo

To remove the .todo file, simply run todo destroy or simply delete the .todo file.

> todo destroy
Deleted: .todo

Simply running todo will display a help menu.

Magnus Balzer <[email protected]>
Simple todo lists

USAGE:
    todo <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    add        Add an item to the todo list
    check      Mark an item on the list as done
    create     Create a new todo list
    destroy    Destroy the todo list
    help       Print this message or the help of the given subcommand(s)
    list       List all items on the list
    remove     Remove an item from the list

Installing

To install todo, simply run this from the root of the project.

cargo install --path .