File: README.md

package info (click to toggle)
vit 2.3.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 1,012 kB
  • sloc: python: 5,028; sh: 103; makefile: 4
file content (66 lines) | stat: -rw-r--r-- 1,985 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# VIT

<img src="images/great-tit-square-small.png" alt="Logo" width="150" height="150" align="right" />

Visual Interactive Taskwarrior full-screen terminal interface.

*For VIT 1.3, [visit here](https://github.com/vit-project/vit/tree/1.3)*


## Features

 * Fully-customizable key bindings *(default Vim-like)*
 * Uncluttered display
 * No mouse
 * Speed
 * Per-column colorization
 * Advanced tab completion
 * Multiple/customizable themes
 * Override/customize column formatters
 * Intelligent sub-project indenting

## Requirements

 * [Taskwarrior](https://taskwarrior.org)
 * [Python](https://www.python.org) 3.7+
 * [pip](https://pypi.org/project/pip)

## Installation

Follow the directions in [INSTALL.md](INSTALL.md)

## Quick start

Run ```vit --help``` from the command line for basic usage instructions.

Run ```vit``` from the command line to start VIT with default config, report, and filters.

While VIT is running, type ```:help``` followed by enter to review basic command/navigation actions.

#### Recommendations:

 * VIT will suggest to install a default user config file if none exists -- it's fully commented with all configuration options, check it out.
 * Do ```vit --help``` *(know the vit command line arguments)*
 * Do ```:help``` in vit *(look over the "commands")*
 * Use an xterm terminal *(for full color support)*
 * For suggestions on further tweaks, see [CUSTOMIZE.md](CUSTOMIZE.md)
 * VIT handles task coloring differently than Taskwarrior, see [COLOR.md](COLOR.md) for more details

#### Troubleshooting:

See [FAQ.md](FAQ.md)

#### Upgrading

Follow the directions in [UPGRADE.md](UPGRADE.md)

#### Development:

Interested in the architecture, or in helping out with development? See [DEVELOPMENT.md](DEVELOPMENT.md)

##### In tribute

 Our friend and collaborator Steve Rader passed away in May 2013.  We owe a lot to Steve for his excellent work, and so vit is preserved, maintained and continued.

 Taskwarrior Team
 support@taskwarrior.org