TODO-TXT(1)

🌸 NAME 🌸

okay so bestie, meet todo-txt — the simple and extensible shell script for managing your todo.txt file. that's the whole vibe. it's TODO-TXT(1) from the General Commands Manual, and it is literally about to become your main character. 💖

✨ SYNOPSIS ✨

todo-txt [-fhpantvV] [-d todo_config] action [task_number]
[task_description]

so yeah, you smash a bunch of flags, then an action, then a task number and/or a task description. that's the entire recipe, periodt. 🎀

💅 OPTIONS 💅

• -@ — Hide context names in list output. Use it twice to show context names again (that's the default, bestie). 🦋
• -+ — Hide project names in list output. Use it twice to show project names (which is, again, the default).
• -c — Color mode. 🌈
• -d CONFIG_FILE — Use a configuration file that isn't the default ~/.todo-txt/config. pick your own adventure, fr fr.
• -f — Forces actions without confirmation or interactive input. no questions, just doing it. 💅
• -h — Display a short help message; same as the action "shorthelp". 🫶
• -p — Plain mode, which turns off colors. (sad beige energy, but sometimes you need it)
• -P — Hide priority labels in list output. Use it twice to show priority labels (default).
• -a — Don't auto-archive tasks automatically on completion.
• -A — Auto-archive tasks automatically on completion.
• -n — Don't preserve line numbers; automatically remove blank lines on task deletion.
• -N — Preserve line numbers.
• -t — Prepend the current date to a task automatically when it's added.
• -T — Do not prepend the current date to a task automatically when it's added.
• -v — Verbose mode turns on confirmation messages. 👀
• -vv — Extra verbose mode prints some debugging information and additional help text. double the yapping, double the lore.
• -V — Displays version, license and credits. 🏆
• -x — Disables TODOTXT_FINAL_FILTER. 🙈

🎀 ACTIONS 🎀

• add, a "THING I NEED TO DO +project @context" — Adds THING I NEED TO DO to your todo.txt file on its own line. Project and context notation optional. Quotes optional. ✨
• addm "FIRST THING I NEED TO DO +project1 @context<break>SECOND THING I NEED TO DO +project2 @context" — Adds FIRST THING I NEED TO DO to your todo.txt on its own line, and adds SECOND THING I NEED TO DO to your todo.txt on its own line. Project and context notation optional. two tasks, one command, iconic.
• addto DEST "TEXT TO ADD" — Adds a line of text to any file located in the todo.txt directory. For example, addto inbox.txt "decide about vacation". 🍓
• append, app ITEM# "TEXT TO APPEND" — Adds TEXT TO APPEND to the end of the task on line ITEM#. Quotes optional.
• archive — Moves all done tasks from todo.txt to done.txt and removes blank lines. spring cleaning, but make it text file. 🧹
• command [ACTIONS] — Runs the remaining arguments using only todo.sh builtins. Will not call any .todo.actions.d scripts. so no add-on shenanigans, just the OGs.
• deduplicate — Removes duplicate lines from todo.txt. bestie said "no twins allowed." 💀
• del, rm ITEM# [TERM] — Deletes the task on line ITEM# in todo.txt. If TERM is specified, deletes only TERM from the task.
• depri, dp ITEM# [ITEM# ...] — Deprioritizes (removes the priority) from the task(s) on line ITEM# in todo.txt. we're un-stressing the list, love that for us.
• do ITEM# [ITEM# ...] — Marks task(s) on line ITEM# as done in todo.txt. the slay action. ✅
• help [ACTION ...] — Display help about usage, options, built-in and add-on actions, or just the usage help for the passed ACTION(s).
• list, ls [TERM ...] — Displays all tasks that contain TERM(s) sorted by priority with line numbers. Each task must match all TERM(s) (logical AND); to display tasks that contain any TERM (logical OR), use "TERM1TERM2..." (with quotes), or TERM1\|TERM2 (unquoted). Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. -TERM). If no TERM specified, lists the entire todo.txt. 🔥
• listall, lsa [TERM ...] — Displays all the lines in todo.txt AND done.txt that contain TERM(s) sorted by priority with line numbers. Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. -TERM). If no TERM specified, lists the entire todo.txt AND done.txt concatenated and sorted. the "show me everything" button.
• listaddons — Lists all added and overridden actions in the actions directory. 👑
• listcon, lsc [TERM ...] — Lists all the task contexts that start with the @ sign in todo.txt. If TERM specified, considers only tasks that contain TERM(s).
• listfile, lf [SRC [TERM ...]] — Displays all the lines in the SRC file located in the todo.txt directory, sorted by priority with line numbers. If TERM specified, lists all lines that contain TERM(s) in the SRC file. Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. -TERM). Without any arguments, the names of all text files in the todo.txt directory are listed. 📂
• listpri, lsp [PRIORITIES] [TERM ...] — Displays all tasks prioritized PRIORITIES. PRIORITIES can be a single one (A) or a range (A-C). If no PRIORITIES specified, lists all prioritized tasks. If TERM specified, lists only prioritized tasks that contain TERM(s). Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. -TERM).
• listproj, lsprj [TERM ...] — Lists all the projects (terms that start with a + sign) in todo.txt. If TERM specified, considers only tasks that contain TERM(s). 💜
• move, mv ITEM# DEST [SRC] — Moves a line from the source text file (SRC) to the destination text file (DEST). Both the source and destination file must be located in the directory defined in the configuration directory. When SRC is not defined it's by default todo.txt.
• prepend, prep ITEM# "TEXT TO PREPEND" — Adds TEXT TO PREPEND to the beginning of the task on line ITEM#. Quotes optional.
• pri, p ITEM# PRIORITY — Adds PRIORITY to the task on line ITEM#. If the task is already prioritized, replaces the current priority with the new PRIORITY. PRIORITY must be a letter between A and Z.
• replace ITEM# "UPDATED TODO" — Replaces the task on line ITEM# with UPDATED TODO. glow-up in progress. ✨
• report — Adds the number of open tasks and done tasks to report.txt. 📊
• shorthelp — List the one-line usage of all built-in and add-on actions. the tl;dr of the tl;dr.

ngl bestie, that's the whole page. every flag, every action, every little detail — preserved like a limited-edition collectible. 🫶

this little love letter comes from the TODO-TXT(1) manual, dated August 2016 — so yeah, it's vintage and it still eats. bye babes, go finish your tasks! 💖✨🎀🦋