lauft / timew-bashcompletion

Bash completion for Timewarrior

timew-bashcompletion

Bash completion for Timewarrior

Installation

1. Clone the repository.
2. Copy or link the bash script to the appropriate place.

Clone the repository

$ git clone https://github.com/lauft/timew-bashcompletion.git

Copy/link the Bash script

You can either copy or symbolic link the bash script to install it. For global installation the target directory is /etc/bash_completion.d:

$ cd /etc/bash_completion.d
$ ln -s /path/to/timew_bashcompletion_repo/timew

Alternatively you can source the completion script in your current shell.

Usage

Type a (partial) Timewarrior command and hit [TAB][TAB]

List available commands:

$> timew[TAB][TAB]
cancel       diagnostics  help         report       stop         untag
config       export       join         shorten      summary      week
continue     extensions   lengthen     show         tag
day          gaps         month        split        tags
delete       get          move         start        track

Complete a partial command:

$> timew st[TAB][TAB]
start  stop

For timew tag you can get a list of available tags after entering an id:

$> timew tag @2 [TAB][TAB]
TAG1    TAG2    TAG3

Environment variables

With increasing size of your Timewarrior database the number of tags can also get quite large. In consequence, the completion of tags can become quite slow.

With the environment variable TIMEW_COMPLETION_TAGS_RANGE, you can set a search range for your tags, e.g. 4w for the last 4 weeks. The default is :all for the complete database. See timew help ranges and timew help hints for details on that.

Limits

Currently, not all commands are fully supported - work in progress!

License

This work is licensed under the MIT licence.

timew-bashcompletion's Issues

Regression: can't complete tags properly if there is a tag description

Hi,

#2 introduced a regression: whenever a tag has a description, since there is no way to separate the description from the tag in the output, the proposed completion is something like "<tag> \ \ \ \ \ <desc>"

If we want both support for spaces in tags and tags with description, until #3 is fixed, either we directly extract the list from ~/timewarrior/tags (but that would need a dependancy on jq or something), or the modification has to be done on timewarrior side: like, allow listing tags without description with a switch, or adding a separator (| or whatever) in timew tags output.

Of course, since a modification is needed on timewarrior, then the best would be to fix GothenburgBitFactory/timewarrior#188 (sadly that's beyond me ;) )

What do you think ?

Wrong address to git repository in README.md

The address for the github repository is given as 'https://github.com/lauft/timew_bashcompletion.git' but the correct address is 'https://github.com/lauft/timew-bashcompletion.git' (note the hyphen instead of underscore).
It's a very minor issue, but I was somewhat confused when github asked me to authenticate myself (which seems to be githubs response to a path that's not found/not public).

timewarrior zsh plugin

Hi,

not an issue, just a heads-up - I've taken the liberty to use your completion script and make it into a zsh plugin suitable for oh-my-zsh, zgen and the like.

You can find it here:
https://github.com/svenXY/timewarrior

Thanks for your great work!

Cheers,
Sven

Use DOM query for tag completion

A reminder to adapt the script as soon as GothenburgBitFactory/timewarrior#188 has been closed