You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Michał Góral 3bf5c8f9de Implemented per-command history 2 weeks ago
ci Generate pages. 5 months ago
devtools First lines of text. 6 months ago
docs Document followurl 1 month ago
src/twc Implemented per-command history 2 weeks ago
tests Fixed incorrect stripping of non-string settings' values. 4 months ago
.coveragerc Fixed handling tasks with quote. 6 months ago
.flake8 Add bottom command line which activates on various user actions. 6 months ago
.gitignore Enable pylint, flake8, coverage, CI 7 months ago
.gitlab-ci.yml Get rid of tox 4 months ago
.pylintrc Fixed pylint & flake8 6 months ago
CHANGELOG Release 0.7.0 1 month ago
LICENSE Initial commit 7 months ago Add new files to manifest 5 months ago
Makefile Get rid of tox 4 months ago Get rid of tox 4 months ago
Pipfile Replace requirements with Pipfile 5 months ago
Pipfile.lock Replace requirements with Pipfile 5 months ago
README.rst Implemented per-command history 2 weeks ago
pyproject.toml Added pyproject.toml 5 months ago
setup.cfg Fixed handling tasks with quote. 6 months ago Fixed python_requires, duh... 5 months ago



**TWC - TaskWarrior Controller** (previously TaskWarrior Curses) is interactive
terminal frontend for task and TODO manager - TaskWarrior.

.. image::
:align: center

For full documentation please refer to the `User Manual


* agendas - display several filters on a single screen simultaneously
(influenced by `org-mode <>`_)
* create, modify, delete, annotate tasks
* bulk edits: select arbitrary tasks and modify them all at the same time
* autocomplete and tab-complete writing task descriptions, annotations, tags
* styling and task formatting (with HTML-like markup)
* tasks and sub-tasks grouping (influenced by
`taskwiki <>`_)
* synchronize tasks with task server
* status line showing arbitrary informations
* configurable key bindings
* search and incremental search of tasks - search can be case-sensitive,
case-insensitive or smart-case (case sensitivite only when there are upper
case characters in searched term)
* history of commands (scrolled with up and down arrows)


TWC works with a concept of "agendas" influenced and borrowed from the mighty
org-mode. Agenda is basically a view of several TaskWarrior filters (called
blocks) displayed on a single screen simultaneously. You can jump between
blocks and single tasks.

To add agenda, first create a configuration file inside
``~/.config/twc/``. It is a regular Python file with exposed variable
``c`` which references a configuration object. You can add new blocks like that:

.. code:: python

agenda='My Agenda',
title='Next Tasks',

agenda='My Agenda',
filter='-WAITING and (+BLOCKING or +BLOCKED) and -INSTANCE',
format='* {description}<info>{tags}</info>')

Style and colors

TWC can be styled in any way you want. To change its colors use `c.set_style()`:

.. code:: python

c.set_style('highlight', 'bg:ansiblue bold')
c.set_style('error', 'fg:white bg:red')

Style examples:

- ``fg:white`` (white foreground, named color)
- ``bg:#000000`` (black background, hexadecimal notation)
- ``bold italic underline blink reverse hidden`` (supported style flags)

Any style name can be used in task formatting. Some interface elements however
use specific style names.

Task Format

Block's format (``format``) is a mix of `Python's string format
<>`_ and HTML-like

You can use any TaskWarrior's attribute name as format's placeholder and it will
be displayed if present.

.. code:: html

<sr left=" ["> right="] ">{id}</sr>{description}

Some additional markup can be added to the tasks. The following tags are

* ``<sr left="[", right="]>text</sr>``: surrounds text with *left* and *right*.
* ``<ind value="A">text</ind>``: if there is any text inside a tag, it will be
replaced with *value*. It's particularily useful for indicating that some
task's property is present, without displaying it (like long list of
``<sr left="[" right="]"><ind value="A">{annotations}</ind></sr>``

Key bindings

By default you can navigate with arrows or vim-style ``j`` and ``k``. Exit TWC
with ``q``.

You can bind and unbind keys with ``c.bind(key, command)`` and
``c.unbind(key)``. Refer to `User Manual <>`_ for
a list of commands and other default key bindings.

Status line

Bottom status line can display arbitrary informations and is configurable by
two variables: ``statusleft`` and ``statusright``. They describe format similar
to the one described in `Task Format`_ The main difference is that task
attributes are referenced by ``{task.<attribute>}`` placeholder and that there
additional placeholders available.

.. code:: python

c.set('statusleft', '{COMMAND} {}')
c.set('statusright', '<ind value=A>{task.annotations}</ind>')

Status line placeholders also include: ``taskrc``, ``command``, ``COMMAND``,
``agenda.pos``, ``agenda.size``, ``agenda.ppos``.


First, make sure that TaskWarrior is installed on your system. TaskWarrior is
packaged for most of Linux distributions. Please refer to TaskWarrior's
`documentation <>`_ for details.

TWC is distributed via `pypi <>`_. You can
install it with pip:

.. code::

$ pip3 install --user twc

or with pip wrapper like `pipsi <>`_:

.. code::

$ pipsi install --python python3 twc

TWC reads your ``taskrc``. It'll use the default one, which is usually located
in ``~/.taskrc``, but you can change it with ``-t`` switch:

.. code::

$ twc -t ~/dotfiles/my_taskrc


TWC works on `Termux <>`_, although there's currently a `bug
<>`_ in tzlocal - a library
indirectly used by TWC to get local timezone information.

Before running TWC on Termux you have to export the following environment

.. code:: shell

export TZ=$(getprop persist.sys.timezone)

Termux emulates scroll events as key presses. You can bind them for easier

.. code:: python

c.bind('right', 'next-agenda')
c.bind('left', 'prev-agenda')


TWC was created by Michał Góral.

TWC is free software, published under the terms of GNU GPL3 or any later
version. See LICENSE file for details.