task-attach is a set of utility scripts to manage attachments in TaskWarrior. Currently, TaskWarrior has no built-in support for attaching external files or resources to tasks (via annotations), and task-attach hopes to address this problem. task-attach is inspired the by the taskopen script, but has the following additional features:
- Support for attachments other than files (i.e., urls and emails)
- A
mutt2taskscript which helps you create tasks from emails - A
open-via-muttscript which opens mutt and jumps to the email corresponding to the given message-id.
To install task-attach, simply run:
pip install task-attach
This installs the scripts:
Upon the first run of any of the task-attach-** scripts, a config file will be created at $XDG_CONFIG_HOME/task-attach/config.yaml. For specific configuration options, please see the generated file.
This script attaches an already existing resource to a task. The basic syntax of the command is as follows:
task-attach-add [-t {file,mail,url}] <id-or-filter> <spec> [<comment> ...]
For example if I want to attach a grocery list to a "Go grocery shopping" task:
$ task add Go grocery shopping
Created task 1.
$ task-attach-add 1 ~/grocery-list The grocery list.
$ task info 1
Name Value
ID 1
Description Go grocery shopping
2020-08-30 12:57:45 The grocery list. file:/home/$user/grocery-list
Or if I want to associate a URL with a task:
$ task add Remember to star!
Created task 2.
$ task-attach-add 2 github.com/alkim0/task-attach github link
$ task info 2
Name Value
ID 2
Description Remember to star!
2020-08-30 13:04:56 github link url:http://github.com/alkim0/task-attach
Similarly, the resource specification can be a message-id (with the enclosing "<>") for an email.
Note that task-attach-add is meant to work only for existing resources, so if the given resource is a file, the path must exist.
The script tries to guess the best type for the given resource specification, but the -t flag can be specified to make the resource type explicit.
Sometimes, I just want to create a new notes file to associate with a task without having to think about it. That is what task-attach-new is for. The syntax is:
task-attach-new [-e EDITOR] [-t ext] <id-or-filter> [<comment> ...]
This creates a new file in the ~/tasknotes directory (configurable) with a randomly generated UUID and opens it up with the specified editor. After editing, saving, and quitting the file, task-attach-new will add the newly generated file as an attachment to the specified task. By default, $EDITOR is used for the editor. The default extension for the generated file is txt, but any other extension may be specified.
Opens a resource for the specified task. Syntax is:
task-attach-open [-x cmd] <id-or-filter>
If a task has more than one attachment, you will be shown an interactive menu to pick from.
By default, $EDITOR is used to open any file resource, and xdg-open is used to open any url. For email resources, the provided open-via-mutt is the default (configurable).
To supplment task-attach-open for emails, the open-via-mutt script is provided. open-via-mutt attempts to open mutt (or neomutt) and jump to/open the email specified by the given message-id by using mutt's limit function. By default, it attempts to find the email in the default inbox, so it may fail if the message is in another folder. However, if emails have been indexed by notmuch, then open-via-mutt will use the message's path and the mailboxes ... clause of the muttrc file to try to the appropriate folder.
This script is meant to be called from within mutt to quickly create a task based on an email. mutt2task expects to read the message from standard input, and interactively asks for the user for a task description. When the task is created and an email resource pointing to the message is automatically attached to newly created task.
For my setup, I have the following aliases:
task config alias.attach "exec '$(which task-attach-add)'"
task config alias.note "exec '$(which task-attach-new)'"
task config alias.open "exec '$(which task-attach-open)'"
In my muttrc, I have:
macro index,pager i "<pipe-message>mutt2task<enter>"