Taskwarrior

-

{{include(wikibar_stand-in)}}

!/attachments/download/44/commands-h.png!

!>/attachments/download/36/gear.png!

see also [[Features]]

(this table is under construction)

_(these need to be sortable via http://tetlaw.id.au/view/blog/table-sorting-with-prototype/ )_

_or using native Redmine methods, whichever is easier_

h2. task

typical command-line usage: *task <command* | *switch> <parameters>*

|_.command|_.canonical|_.sw|_.parameters|_.interactive|_.status|_.version|_.notes|

|[[add]]||-a|[tags][attrs] desc... |(a)dd| !/attachments/download/20/green-checkmark.png! |1.2|Adds a new task|

|[[append]]||-A|ID [tags][attrs] desc...|(A)ppend| !/attachments/download/20/green-checkmark.png! ||Appends to existing task|

|[[annotate]]||-o|ID desc... |ann(o)te| !/attachments/download/20/green-checkmark.png! ||Adds annotation to existing task|

|[[report.completed|completed]]|||[tags][attrs] desc... || !/attachments/download/20/green-checkmark.png! ||Chronological listing of all completed tasks matching the specified criteria|

|ID|||[tags][attrs][desc...]|| !/attachments/download/20/green-checkmark.png! ||Modifies the existing task with provided arguments|

|ID /from/to/||||?| !/attachments/download/20/green-checkmark.png! ||Performs one substitution on the task description|

|ID /from/to/g||||?| !/attachments/download/20/green-checkmark.png! ||Performs all substitutions on the task description|

|[[edit]]||-E|ID|(E)dit| !/attachments/download/20/green-checkmark.png! ||Launches an editor to let you modify all aspects of a task directly, use with caution|

|[[duplicate]]|||ID [tags][attrs][desc..]|&| !/attachments/download/20/green-checkmark.png! ||Duplicates the specified task|

|[[delete]]||-D|ID|(D)elete, del| !/attachments/download/20/green-checkmark.png! ||Deletes the specified task(s)|

|[[undelete]]||-U|ID|(U)ndelete| !/attachments/download/20/green-checkmark.png! ||Undeletes the specified task, provided a report has not yet been run|

|[[info]]||-i|ID|(i)nfo| !/attachments/download/20/green-checkmark.png! ||Shows all data, metadata for specified task|

|[[start]]||-s|ID|(s)tart| !/attachments/download/20/green-checkmark.png! ||Marks specified task as started|

|[[stop]]||-s|ID|(s)top| !/attachments/download/20/green-checkmark.png! ||Removes the 'start' time from a task|

|[[done]]||-d|ID [tags][attrs][desc..]|(d)one| !/attachments/download/20/green-checkmark.png! ||Marks the specified task as completed|

|[[undo]]||-u|ID|(u)ndo| !/attachments/download/20/green-checkmark.png! ||Marks the specified done task as pending, provided a report has not yet been run|

|[[update]]|||||||used to make changes to records|

|[[report.projects|projects]]||-p||(p)rojects| !/attachments/download/20/green-checkmark.png! ||Shows a list of all project names used, and how many tasks are in each|

|[[report.tags|tags]]||-T||(T)ags| !/attachments/download/20/green-checkmark.png! ||Show a list of all tags used|

|[[report.summary|summary]]||||"."| !/attachments/download/20/green-checkmark.png! ||Shows a report of task status by project|

|[[report.timesheet|timesheet]]|||[weeks]||||Shows a weekly report of tasks completed and started|

|[[history]]||-h||(h)istory|||Shows a report of task history, by month|

|ghistory||||| !/attachments/download/20/green-checkmark.png! ||Shows a graphical report of task history, by month|

|[[next]]||-N|[number]|(N)ext| !/attachments/download/20/green-checkmark.png! ||Shows the most important tasks for each project|

|[[calendar]]||-C|[number]|(C)alendar|||Shows a monthly calendar, with due tasks marked|

|[[report.active|active]]||||| !/attachments/download/20/green-checkmark.png! ||Shows all task that are started, but not completed|

|[[report.overdue|overdue]]||||!| !/attachments/download/20/green-checkmark.png! ||Shows all incomplete tasks that are beyond their due date|

|[[report.stats|stats]]||||#| !/attachments/download/20/green-checkmark.png! ||Shows task database statistics|

|import||||F12| !/attachments/download/20/green-checkmark.png! ||Imports tasks from a variety of formats|

|export|||[tags][attrs]|F12| !/attachments/download/20/green-checkmark.png! ||Exports all tasks as a CSV file|

|color||||| !/attachments/download/20/green-checkmark.png! ||Display all possible colors|

|version||||(V)ersion| !/attachments/download/20/green-checkmark.png! ||Shows the task version number|

|help||||F1, ?| !/attachments/download/20/green-checkmark.png! ||Shows the long usage text|

|[[report.custom|custom]]|||[tags][attrs][desc...]|F12| !/attachments/download/20/green-checkmark.png! ||My custom report|

|[[report.list|list]]|||[tags][attrs][desc...]|F3,F12| !/attachments/download/20/green-checkmark.png! ||Lists all tasks matching the specified criteria|

|[[report.long|long]]|||[tags][attrs][desc...]|F4,F12| !/attachments/download/20/green-checkmark.png! ||Lists all task, all data, matching the specified criteria|

|[[report.ls|ls]]|||[tags][attrs][desc...]|F2,F12| !/attachments/download/20/green-checkmark.png! ||Minimal listing of all tasks matching the specified criteria|

|[[report.newest|newest]]|||[tags][attrs][desc...]|F12| !/attachments/download/20/green-checkmark.png! ||Shows the newest tasks|

|[[report.oldest|oldest]]|||[tags][attrs][desc...]|F12| !/attachments/download/20/green-checkmark.png! ||Shows the oldest tasks|

|task|||[tags] [attrs] desc||||invoked without parameters, will start an interactive session, at a default screen;Next Actions|

|||||arrow up/dn|||to select (see:selection)|

|||||PgUp/PgDn|||scroll through lists (a page at a time) but when on single screen reports (like (i)nfo, or (#)stats) PgUp (or PgDn) will flip to the next (or previous) record|

|||||Home/End|||in lists; top/bottom, in "single screen" first/last of series, arrow keys left and right move selected column (which changes sort keys) "<" to reverse sort order (effect not "sticky") ">" to reset sort order|

|||||<tab>|||is used primarily for completion, but may be used with (proposed) data.[[forms]]|

|||||<enter>|||is highly context sensitive, but tends to drill down (selection -> info -> form -> edit) as well as confirming search string (find mode) and then returning to onekey mode|

|||||<esc>|||is as context sensitive as <enter> but tends to back out (canceling dialogs, abandoning search strings and returning to onekey, resetting some things to defaults) and ultimately, exiting the program|

|||||f1 - (?)|||help|

|||||f2-f10|||trigger top 9 reports (of unlimited #, can be either task or contact reports)|

|||||f11|||toggles "full screen" mode (more like "hide certain elements" mode) <esc> also un-hides|

|||||f12|||reports / exports / imports list (scroll, select, edit, move-up-down, edit)|

|break||-b|h d w m y|(b)reaks|||break letter to toggle or "b" to cycle|

|[[report-contacts|contacts]]||-c|[tags] [attrs] [desc]|(c)ontacts|||toggles inclusion of contact data, to be combined with task searches. (contacts at the top)|

|||(f)ind or "/"|||||switches to live-search mode, <enter> to save search, <esc> to return to onekey mode|

|find||-F||(F)ind-list or "\"|||prompt for name to save search (if valid) and list saved searches|

|groups||-g|[tags][attrs][desc]|(g)roups|||listing of groups (contacts)|

(G)             RESERVED for a milestone feature

                      to be announced on release of taskv2.0-beta1

(h)istory     not sure yet...

(H)             ghistory

(i)nfo          ubiquitous info screen with all record details <enter> to edit, if "none" selected, displays stats

(I)ndex       displays full contact listing and switches to Index-key mode (scroll to alpha-numeric)

(j)ournal     displays journal   ->[append text] or <enter> to edit

(J)             RESERVED

(k)eys        displays full key reference "card", invalid-for-context entries "grayed out"

(K)?

(l)ist           (contextual)  from any listing, resets to default column selection and/or sort order,

                    else, if-at-defaults or from anything-other-than-a-listing, takes task to default listing of report f2

                    if on default listing of default report (f2) repeatedly pressing "l" cycles numerically through 9 reports

                    just like pressing keys f2 through f10, sequentially.

(L)               RESERVED for the key taskv3.0 milestone feature

                     to be announced on release of task2.0 beta1

(m)             RESERVED

(M)             RESERVED    

(n)ext         manually mark (or un-mark) selected item(s) as Next Actions (could be as simple as adding +NA tag)

(N)ext         user definable list of Next Actions, both automatically and manually selected (interactive tasks default view)

ann(o)te     ->[tags] [attrs] annote text     

(O)pen        opens console file manager ()

(p)rojects    full list of projects (scroll, select, edit)

(P)rint         (TBD) based on export.pdf.faves            ?

(q)uit          are you sure (Y/n) ?   ...or not

(Q)             quits with no prompt

(r)c            display/ edit task configuration file (tempted to use "|" (pipe) or ";")

(R)eview

(s)tart/stop  toggle started ("stop" should create annotation with <starttime - stoptime> THEN clear starttime)

(S)ync        ... this feature may require some further discussion  (in the distant future ;-)

(t)ag           ->  tags [attrs]       added (or removed) to (or from) selected tasks

(T)ags         toggle list of tags (scroll, select, edit)

(u)ndo         are you sure ?

(U)ndelete    really ?

(v)erbose     toggle display of verbosity-bar, for verbose confirmation stuff

(V)ersion     toggle credits, ASCII likeness of Paul, proper bank account deposit info, GPL, etc

(w)ait          toggle task(s) status:waiting

(W)aiting     show report of tasks with status:waiting

e(x)ecute     launches exec:<action> script if any,

                     else looks for first key-action words in <desc> corresponding to existing scripts in .taskrc

(X)               lists active "verbs", alert:<time>s and exec:<script>s (scroll, select, edit, execute)

m(y) stuff     personal preferences, personal stats, my contact info

cr(Y)pto       to keep things safe

(z)show.done toggle show done

(Z)show.all   unhide status:waiting, status:someday and bypass user-created exclusions list (.taskrc)

?                 help

:                  toggle display of full list of attributes in use

/                  invoke (f)ind mode

\                  saved searches

.                  task summary

,                  task active

!                  task overdue

$                 task sum ? just kidding ! (no, really)

&                 duplicate task

*                  displays random task

-                  decrements rating:<int> (to tweak sort within pri:)

+                 increments rating:<int> (no rating treated as rating:3)

@                lists contexts (TBD)

#                 show stats (also seen when find result = no match)

%                show graphical stats

^                  add/ change/ remove dependency (when available)

BkSpc         revert