Skip to content

fieldghost/TodoMe

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

TodoMe

Create, list, complete, delete, and clear your to-dos straight from the terminal, baby.

TodoMe is a minimal, fast, and reliable CLI tool to help you track your daily tasks without ever leaving your command line.


Prerequisites

The core script runs flawlessly on any POSIX-compliant system (Linux, macOS, WSL). However, if you want to use the remind feature, your system needs notify-send to push desktop notifications.

  • Ubuntu / Debian: sudo apt-get install libnotify-bin
  • Other Linux Distributions: Install it via your standard package manager, or visit vaskovsky.net for guidance.
  • macOS: Note: notify-send is not native to macOS. The core to-do list will work perfectly, but the remind feature will prompt you to install a compatible notification wrapper.

Installation

  1. Download or clone the script to your machine.
  2. Make it executable:
 chmod +x TodoMe.sh
  1. Move it to a safe location (e.g., ~/scripts/TodoMe.sh).
  2. Add an alias to your ~/.bashrc (or ~/.zshrc) for quick access:
 alias todo="~/scripts/TodoMe.sh"
  1. Source your config:
 source ~/.bashrc

(Note: TodoMe automatically creates a ~/.todo_list_data file in your home directory to store your tasks).


Usage

Syntax:

todo [ command ] [ argument ] [ minutes ]

Commands

  • **todo add <task...>** Adds a new task to your list. No quotes required! Example: todo add Pet the dog
  • **todo list** Displays all current tasks with their line numbers and completion status.
  • **todo done <number>** Marks a specific task as completed [x]. Example: todo done 1
  • **todo remove <number>** Deletes a specific task. Prompts for confirmation before deleting. Example: todo remove 2
  • **todo clear** Wipes your entire to-do list. Prompts for confirmation.
  • **todo remind <number> <minutes>** Sends a one-shot desktop notification for a specific task after X minutes (runs a safe background process, does not clutter your cron schedule). Example: todo remind 1 15 (Reminds you of task #1 in 15 minutes).
  • **todo help (or -h, --help)** Displays the built-in help menu and usage syntax.

Free to use. Open source. Lovely.

About

create, list, complete, delete and clear todo's straight from the terminal baby

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages