21 releases (10 breaking)

new 0.11.2 Jul 9, 2025
0.10.0 Jul 7, 2025

#31 in Configuration

Download history 579/week @ 2025-06-25 1265/week @ 2025-07-02

1,844 downloads per month

MIT license

30KB
744 lines

todo

An easy way to manage your todos

Installation

cargo install to-dos

Usage

$ cd any_directory
$ todo

A todo file for this directory will be created under ~/.todo/todos/

For windows, %USERPROFILE%\.todo\todos\

Usage: todo [COMMAND]

Commands:
  sync     Create a hard link to this directory's todo file in the current directory
  unsync   Undo the sync command
  list     List the todos for the current directory
  config   Interactive configuration for the todo cli
  remove   Removes the todo for the current directory. Use todo help remove for other options
  update   Update todo cli
  search   Fuzzily find todos
  check    Fuzzily find todos, check them
  uncheck  Fuzzily find todos, uncheck them
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Configuration

The config file is located at ~/.todo/config.toml

For windows, %USERPROFILE%\.todo\config.toml

Default config:

filename = "todo"
extension = ".md" # must include the dot
editor = "$EDITOR" # can be an environment variable or a hardcoded command

Note:

  • On Windows, $EDITOR isn't set to anything, you can
    • Set it globally (setx EDITOR notepad)
    • Change the editor in the config

To-dos:

  • Publish on crates.io
  • Configure editor (defaults to $EDITOR)
  • Configure file type (defaults to markdown)
  • Sub-commands, args
    • sync/unsync
    • remove
    • config
      • list
    • update
    • search
    • check/done
    • uncheck/undo
  • Windows support
  • Test on MacOS

Dependencies

~9–25MB
~314K SLoC