Plan

Plan is a simple command-line TODO manager. It takes a heirarchial approach to managing TODOs, so you can openly group items into projects.

Intallation

Installation is as simple as gem install plan

Creating Items

To create an item you can use the plan create command, like so:

$ plan create open-source

If the item that you want to create has spaces or special symbols, just surround it with "'s like:

$ plan create "open source"

Lists

You can list the current items in your TODO list by using plan list:

$ plan list
todo
-- open source

Once you have items in your list you can add sub-items like:

$ plan create open-source "add that cool feature"

which will place "add that cool feature" underneath open-source in the heirarchy:

$ plan list
todo
-- open source
---- add that cool feature

As a quicker way to add tasks you can use substrings like:

$ plan create op "add cool feature"
$ plan create op "do other thing"

do add sub-items to the open-source item quickly and easily.

Finish

When you have finished a task, you can select the same way, like

$ plan finish "open-source" "add cool feature"

To mark an item as finished. This works with groups and single items like you'd imagine: by finishing all sub-items.

You can use shorthand here also, so something like:

$ plan finish open cool

would be equivelant to the above.

Unfinish

If you mistakently mark something finished, you can use unfinish to reverse it just the same:

# do nothing
$ plan finish open cool
$ plan unfinish open cool

Cleanup

The dates you finish things will show up in list calls, until you run cleanup on a selection to hide them. The same selectors work, and the cascading is taken care of automatically.

$ plan list open
open-source
-- something (finished)
$ plan cleanup open
open-source

Storage

By default, plan stores its data in ~/plan ($HOME/plan) - to change that just export an environmet variable called PLAN_DATA_PATH with the path you want, like:

$ export PLAN_DATA_PATH="/some/location/planfile"

Author

John Crepezzi

License

MIT License (See attached LICENSE file)