Getting Started

Get up and running with md2do in minutes.

Installation

Global Installation (Recommended)

Install md2do globally to use it anywhere:

npm

npm install -g @md2do/cli

pnpm

pnpm add -g @md2do/cli

yarn

yarn global add @md2do/cli

Local Installation

Install in your project:

npm

npm install @md2do/cli

pnpm

pnpm add @md2do/cli

yarn

yarn add @md2do/cli

Then use via npx:

npx md2do list

From Source

Clone and build from source:

git clone https://github.com/TeamNickHart/md2do.git
cd md2do
pnpm install
pnpm build
pnpm link:cli

Quick Start

1. Create a Markdown File

Create a file called tasks.md:

# My Tasks

- [ ] Review pull request @nick !! #code-review (2026-01-25)
- [ ] Update documentation @jane ! #docs
- [x] Fix bug in parser @alex !!! #bug (2026-01-18)

2. List Your Tasks

md2do list

You should see:

Found 3 tasks
  ✓ 1 completed | ○ 2 incomplete

  ○ !! Review pull request (2026-01-25) @nick #code-review
    file:///path/to/tasks.md:3

  ○ ! Update documentation @jane #docs
    file:///path/to/tasks.md:4

  ✓ !!! Fix bug in parser (2026-01-18) @alex #bug
    file:///path/to/tasks.md:5

3. Try Filtering

Filter by assignee:

md2do list --assignee nick

Filter by priority:

md2do list --priority urgent

Show only incomplete tasks:

md2do list --incomplete

4. View Statistics

Get a task breakdown:

md2do stats

# Group by assignee
md2do stats --by assignee

# Group by priority
md2do stats --by priority

Next Steps

Now that you have md2do installed:

• Learn the task format - Understand all supported metadata
• Explore filtering - Master powerful filtering options
• Configure md2do - Set up defaults and preferences
• Set up Todoist - Enable Todoist synchronization
• Try AI integration - Use Claude Code with md2do

Getting Help

If you run into issues:

• Check the CLI Reference for command documentation
• Browse Examples for common use cases
• Open an issue on GitHub