TODO-CLI

TODO-CLI is a small command-line app for creating and managing project task lists from the terminal. It stores tasks in Markdown files, so your todo list can stay beside the code it belongs to.

Features

• Open and edit .todo.md files from an interactive terminal UI.
• Mark tasks as complete or mark them for deletion.
• Create a todo file for the current project or a custom path.
• Generate tasks from TODO: comments found in source files.
• Open the recent-file hub to jump between todo lists.

Requirements

• Node.js
• npm

Installation

Install the published package globally:

npm install -g @cicolas/todo-cli

After installation, run the CLI with either command:

todo
todo-cli

Usage

Create the default .todo.md file in the current directory:

todo init

Open the default todo file:

todo

Open a specific Markdown todo file:

todo path/to/tasks.md

Generate todo items from TODO: comments in a directory:

todo generate .
todo generate src -o generated-tasks.md

Open the recent todo-file hub:

todo hub
todo hub --sort

Use -g or --global with supported commands to use the global todo path instead of the current project path.

Interactive Controls

Use Up and Down to move through the list. Use Space or Enter to select the highlighted item. Use Left and Right to switch between complete/open mode and delete mode. Press Ctrl + C to save and exit.

The todo screen includes actions for creating a new task, saving, deleting marked tasks, and deleting completed tasks.

Todo File Format

TODO-CLI reads Markdown checklist items:

# Todo

Project tasks

- [ ] write documentation
- [x] publish package

Generated tasks are appended to the selected todo file and duplicate task names are skipped.

Development

Install dependencies before running the CLI locally:

npm install
node bin/index.js --help

Run the linter with:

npx eslint bin/index.js bin/scripts/generate.js

There is currently no automated test suite; use the commands above for manual smoke testing when changing CLI behavior.