taskfinder

Find tasks within a particular set of files.

By default, these files are defined as .md and .txt files in your home directory. However, both the directory and the extensions are configurable. Upon first run, this program will create a configuration file at $HOME/taskfinder/config.toml. Edit the file to change these defaults. Also configurable are:

• how many days constitutes a file being stale
• whether to include completed tasks by default

How tasks get identified and extracted from files:

• the term "TODO" (in caps) must be in the text of the file
• [ ] or [] identifies an incomplete task
• [X] or [x] is a completed task
• [/] is a partially completed task

If a file is considered stale (last modified more than days_to_stale days ago, with default of 365 initially set in the config file), no tasks from it will be returned, unless the --stale flag is used. A file can also be explicitly marked as stale by including the text "@stale" within it.

Finally, note that:

• priorities are essentially special note-level tags.
• tags and priorities are actually just whatever string you pass, so you may follow whatever convention you like. (For me, tags are in the form "@sometag" and priorities in "pri@1", "pri@2", etc.)

See tf --help.

This is still an early work in progress, but you can install with cargo install taskfinder.