After pulling this repository,
$ cabal install
Todo can be run just with
todo
This will launch the interactive mode of the program.
Todo also supports CLI parameters. Here they are:
todo [add/remove/view] [filename] [parameter for first argument]
WARNING: Currently, TODO only supports filenames ending with .txt
, otherwise your filename will be treated as a TODO and be added
to the default list!
Todo uses the file ~/.config/todo.txt
as default. The main commands are:
todo add #Adds TODOs to your list.
todo view #Prints out your todo list.
todo remove #Removes TODOs from your list.
todo version #Prints out version.
todo help #Prints out help message.
These commands are self-explanatory.
The parameters for add are just the filename and things you want to add to your TODO list.
For example
todo add "Say hello to the world"
Will add "Say hello to the world" to your default TODO list.
To add your TODO to a different file (you guessed it):
todo add helloworld.txt "Say hello to the world"
This will create a helloworld.txt file in the current directory if it doesn't exist, otherwise add the string to your list.
You can also add multiple TODOs with a single command like this:
todo add "Foo" "Bar" "Baz"
The parameters for remove are the filename, and the number at which the to-be-removed TODO is at, and/or a simple phrase that the to-be-removed TODO contains.
An example with indexes as the parameter:
An example with keywords as the parameter:
You can also combine both types of parameters:
todo remove "Foo" 1
View only takes filenames as the parameter.
Feel free to contribute anything at all, if you feel like cracking your head over a trivial project is what you want.