jonasgeiler / todolist-lua

🧪 A simple todolist for the command line written in Lua.

todolist-lua

A simple todolist for the command line written in Lua.

This is a simple CLI program that I wrote for fun which allows users to create and manage todolists on the command line.

It is actually a rework of a very old project of mine, which was one of the first projects I ever uploaded to GitHub!
If you want to see the old version, check out the old-version tag.
But be warned of the bad code :D

Requirements

• LuaJIT 2.1 or Lua 5.1 (newer versions might work but not tested)

Usage

Use ./todolist to run the CLI:

$ ./todolist add ./todo.md 'Write tests'

$ ./todolist get ./todo.md 1
1. [ ] Start reworking todolist-lua

$ ./todolist check ./todo.md 1

$ ./todolist list ./todo.md
Todolist "./todo.md" - 4 todos (3 unchecked, 1 checked)
-------------------------------------------------------
1. [X] Start reworking todolist-lua
2. [ ] Finish reworking todolist-lua
3. [ ] Write documentation
4. [ ] Write tests

Run ./todolist --help for general help and ./todolist <command> --help for more information on a command.

About todofiles

The todofiles that this CLI creates and manages are basically just Markdown files and can be viewed in any Markdown editor (needs GitHub-flavored Markdown support for showing checkboxes). This makes them easy to view on GitHub and also more manageable with git. Here's what a todofile looks like:

1. [X] Todo 1
2. [ ] Todo 2
3. [X] Todo 3
4. [ ] Todo 4

As you can see it's just an ordered list of checkboxes with text.

Warning

I have not added support for any content in the todofile other than the actual list of todos - any additional headings or paragraphs will be overwritten or appended to the previous todo item!