Skip to main content

A powerful, keyboard-driven terminal application for managing todo.txt files.

Project description

TodoTxtTUI

A powerful, keyboard-driven Terminal User Interface (TUI) for managing your todo.txt file.

Skip to Installation (pip3).

Screenshot

Features

  • Priorities: Tasks can have priorities and are color-coded accordingly.
  • Sorting: Tasks sorted by due date, priority and alphabetical (in that order).
  • Due Dates: Tasks can have due dates and are grouped by them.
    • Natural Language Processing (NLP): For example, due:tomorrow.
  • Recurring tasks: Tasks can have a recurrence pattern, automatically creating new tasks upon completion. For example rec:1d or rec:+1y.
  • Projects/Contexts: With autosuggestions and autocompletion.
  • Archiving: Completed tasks can be moved to a done.txt.
  • Search: Quickly find the tasks you're looking for.
  • Markdown links: Yes.
  • Sync: Changes made in todo.txt outside the application will be reflected in the app.
  • Keyboard driven: Navigate and manipulate everything from your keyboard with vim-inspired keys.
  • Much more...

Keybindings

  • j/down: Move cursor down
  • k/up: Move cursor up
  • gg: Go top of list
  • G: Go to bottom of list
  • n: Add new task (enter to save, esc to dismiss)
  • e: Edit existing task (enter to save, esc to dismiss)
    • tab: Autocomplete suggested
  • x: Toggle task complete/incomplete
  • X: Complete and archive task immediately
  • A: Archive completed tasks to done.txt
  • D: Delete task
  • P: Postpone task (set due date tomorrow if task has existing due date)
  • f: Focus search field (enter to focus task list)
  • r: Reset search/Refresh task list
  • u: Open URL in focused task
    • If task has multiple URLs, press u followed by e.g. 2 to open the second URL
    • U Open all URLs in task
  • q: Quit application

Priorities

(A) This task is most important
(B) This task is moderately important
(C) This task is less important
... and so on

Due Dates

Specify using due: followed by date YYYY-MM-DD or use natural language like due:tomorrow.

Example task: Hello world due:2024-05-18.

NLP (Natural Language Processing)
Convert natural language like due:tomorrow into the correct yyyy-mm-dd formatted date. Logic for days of week sets due date next occurrence of day in question, even if today is that day. That means that if today is Tuesday and you write due:tue, the date will be set to Tuesday of next week. The same logic applies to next week/month.

  • due:tom or due:tomorrow.
  • due:tue or due:tuesday: Set date to the upcoming Tuesday (works for all days).
  • due:nw or due:nextweek: Monday the following week.
  • due:nm or due:nextmonth: 1st of next month.
  • due:10jan: Upcoming January 10th.
  • due:10jan2027: January 10th, 2027.

Recurring tasks

Example task: Hello world due:2024-05-18 rec:5d. When completing the task, a new task will be created 5 days in the future based on the date when you completed the task

Recurrences can be specified in: d (days), w (weeks), m (months), y (years).

Strict recurrence
Use the + symbol. When completing the task, a new task will be created 5 days after the tasks' due date regardless of the date when you complete the task. Useful for keeping track of birthday's and similar things where the recurrence date must always fall on the same date regardless of when you complete the task.

Example: (A) Marie +birthday @home due:2023-10-30 rec:+1y. Marie's birthday will repeat on Oct. 30th every year.

Projects and Contexts

This is a +project and this is a @context.

Example: Hello world +server @pc.

Task normalization/reconstruction

Automatically fixes mangled tasks.

Enter a task like this:

  • Go +someProject to @work [YouTube](https://youtube.com) and watch [these beautiful dogs!](https://www.youtube.com/watch?v=1VHRiwma05c). rec:+1d @pc +hello due:2023-01-01

It will be reconstructed like this:

  • Go to [YouTube](https://youtube.com) and watch [these beautiful dogs!](https://www.youtube.com/watch?v=1VHRiwma05c). +hello +someProject @pc @work due:2023-01-01 rec:+1d

And display like this:

Reconstructed task

Installation

pip3 install todo-txt-tui

You will be notified if a new version is available.

Usage

todo-txt-tui /path/to/todo.txt

On linux you can create an alias to speed things up. Example: alias todo="todo-txt-tui /path/to/todo.txt". Then you can simply type todo in your terminal and the app will start and open your preferred todo.txt list.


Original idea
Read more about todo.txt at todotxt.org. Gina Trapani originally came up with the idea. It has since been extended, e.g. with recurring tasks and other features.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

todo-txt-tui-0.0.3.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

todo_txt_tui-0.0.3-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

Details for the file todo-txt-tui-0.0.3.tar.gz.

File metadata

  • Download URL: todo-txt-tui-0.0.3.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for todo-txt-tui-0.0.3.tar.gz
Algorithm Hash digest
SHA256 f16579053d06a76cc0d578a9aa24eaf81b444685deef7649a02e454ce5d7cabd
MD5 1fe4f7dab5ac47ddbac4921d2685336f
BLAKE2b-256 14d5aac30a71608e6dc8ddc390f5a066ee8917becfa3c40b97725b48ab711747

See more details on using hashes here.

File details

Details for the file todo_txt_tui-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: todo_txt_tui-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 17.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.12

File hashes

Hashes for todo_txt_tui-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2d3017e3a8e5e51a7f47b519f7120bf0ccf73efe50caedb9073b8482b6fbdaf5
MD5 773c888b4b2fc7460dd5f8b8aaab2b7a
BLAKE2b-256 7839e84b72444fe443033eb53b5f9ca7fcc60090fc59e7dd2e31b44516ef1e14

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page