A basic CLI to manage markdown formatted TODO lists.
Features
- Create and Manage TODO files with multiple lists
- Personal TODO files in the Home directory
- TODO files are saved as markdown
- NCurses based Terminal UI
Take a look at this project's TODO.md. It was created using this CLI!
Installation
npm install todocmd -g
That's all! (assuming you have node already installed)
The first time you use this CLI, it will create a directory to store a config.json file.
This is also the location where global TODO files will be stored.
- Linux : HOME/.config/todocmd
- Mac : HOME/Library/Preferences/todocmd
- Windows : APPDATA/todocmd
Usage
Here is a short summary of the commands that TodoCMD offers. You can use the --help (-h) flag on any command to get more information about the specific options that this command has. For a more detailed explanation, go to the wiki.
todo new
This command will create a new markdown file with a title and a description.
todo list
This command will list all the TODO lists a file has. If the name of a list is provided, it will instead show all the items from that list.
todo list add
Use this command to add a TODO list to a file.
todo list rm
Use this command to remove a TODO list to a file.
todo add
This command will add an item to a TODO list.
todo rm
This command will remove an item from a list.
todo check
This command will mark an item as done.
todo uncheck
This command will mark an item as not done.
Background
After learning a lot about JS and NodeJS through books, guides and videos, I decided to put my newfound skills to the test and create an application. I tend to use a lot of TODO files in my personal projects, and wanted a good way to manage them, whilst still being able to easily read the raw file. Thus, the idea for TodoCMD was born.