Skip to content
candy-toolsPublic

About

minimal TODO list CLI

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

todo

A minimalistic, keyboard-driven TODO manager for the terminal. It opens a per-directory JSON file (.todo.json) as a task list — categories hold tasks, and nested tasks are subtasks. Work is organized in sprints, in two workspaces you switch between with b and s: the Backlog holds the tasks not yet planned, and the Sprints workspace lists the sprints beside the selected one's board with its Next, In Progress and Done sections. a assigns a backlog task to a sprint, and a / A move a task across the columns. Everything you do is saved straight away, and an existing TODO.md is imported automatically the first time you run it.

Built with the Charm stack: Bubble Tea, Bubbles, and Lipgloss, with Cobra for the CLI.

todo — a keyboard-driven TODO manager for the terminal

Install

todo is a single, dependency-free binary (pure Go, no CGO). Prebuilt archives, a Debian package, and a macOS cask are published on every tagged release.

macOS (Homebrew)

A macOS cask is published to the candy-tools/homebrew-tap tap on every tagged release. Add the tap, then install:

brew tap candy-tools/tap
brew install --cask todo

brew upgrade tracks future releases. The binary isn't notarized, so the cask strips the Gatekeeper quarantine flag on install — no "todo is damaged" prompt.

Debian / Ubuntu

Download the .deb for your architecture from the releases page and install it:

sudo apt install ./todo_*_amd64.deb

From source

With a Go 1.26+ toolchain installed:

go install github.com/candy-tools/todo@latest

Or grab a prebuilt tar.gz (.zip on Windows) for your OS/arch from the releases page.

Documentation

Usage — the task tree, every key, the search filter, live reload, markdown import, and how the list is stored — is documented in DOCUMENTATION.md.

Develop

Requires Go 1.26+. The full toolchain also needs golangci-lint, goreleaser, and go-licence-detector. todo has no runtime dependencies — it's a single static binary.

make help         # list all targets
make test         # run tests with coverage
make lint         # golangci-lint
make vet          # go vet
make coverage     # enforce the per-package coverage threshold

Run

make run          # imports example.md into a temp file and opens it
# or plain go:
go run . path/to/my.json

Build

make build        # goreleaser snapshot build for the current OS/arch → ./dist
# or plain go:
go build ./...

Release

Releases are published by pushing a semver tag from a clean main branch. The tag triggers the Release workflow, which runs GoReleaser to build and publish the archives, .deb, and Homebrew cask.

make tag version="v1.2.3"

make tag refuses to run unless you're on main with a clean working tree, then creates and pushes the vX.Y.Z tag.

About

minimal TODO list CLI

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages