Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

File worker

Flag: --todo-path
Env: $TODOTXT_TUI_TODO_PATH
Conf: todo_path
Specifies the path to the task storage. The storage format is selected automatically:
  • Directory — iCalendar format (vdirsyncer-style, one .ics file per task).
  • File ending in .ics or .ical — iCalendar format.
  • Any other file — todo.txt format.

See File Formats for a detailed description of each format and its limitations.

default: $HOME/todo.txt


Flag: --archive-path
Env: $TODOTXT_TUI_ARCHIVE_PATH
Conf: archive_path
Specifies the path to the archive file, where completed tasks are stored separately. If not provided, completed tasks remain in the same storage as pending tasks.

Note: This option is only used by the todo.txt format. It is ignored when todo_path points to a directory or an .ics/.ical file.


Flag: -d, --autosave-duration
Env: $TODOTXT_TUI_AUTOSAVE_DURATION
Conf: autosave_duration
Defines the interval, in seconds, for automatic saving of changes to the `todo.txt` file. Is used only if `save_policy` is set to `AutoSave`.

default: 900


Flag: -f, --file-watcher
Env: $TODOTXT_TUI_INIT_WIDGET
Conf: file_watcher
Enables or disables the file-watcher functionality. When enabled, the application monitors the `todo.txt` (_and optionally `archive.txt`_) file for external changes and automatically reloads.

default: true


Flag: -i, --save-policy
Env: $TODOTXT_TUI_SAVE_POLICY
Conf: save_policy
Determines the policy for saving changes to the todo.txt file and, optionally, the archive.txt file.
  • ManualOnly: Requires explicit user action to save changes.
  • AutoSave: Automatically saves changes at intervals defined by `autosave_duration.
  • OnChange: Saves changes immediately whenever modifications occur.

default: OnChange