1tasksh(1) User Manuals tasksh(1)
2
6 tasksh - Interactive taskwarrior shell
7
10 tasksh
11 tasksh --version
12
15 Tasksh can be used to create a more immersive taskwarrior environment.
16 Any task command you run outside the shell can also be run inside the
17 shell, without the need to prefix every command with "task".
18 When built with libreadline, tasksh provides command editing and his‐
20 tory.
21 Tasksh has an integrated 'review' command that leads you through an
23 interactive review session.
24 Tasksh supports all recent versions of Taskwarrior.
26
29 Tasksh supports the following commands. All other commands are passed
30 intact to Taskwarrior.
31 diagnostics
34 Displays settings pertinent to tasksh, for diagnosing problems.
35 exec <commands>
38 This command allows you to run shell commands from within
39 Tasksh. This is ideal for accessing man pages such as this. The
40 '!' command can be used in place of the 'exec' keyword. Once the
41 command is run, control returns to Tasksh.
42 exit/quit
45 These commands cause tasksh to terminate, returning you to your
46 system shell.
47 help Shows a summary of commands, and how to obtain help.
50 review [N]
53 Begins an interactive review session, where you can mark tasks
54 as reviewed, edit them using your text editor, provide modifica‐
55 tion commands, or skip them. You can terminate a review session
56 at any time, and the next review session will resume at the
57 right place.
58 To find tasks needing review, the '_reviewed' custom report is
60 created and run, which filters tasks that have a missing
61 'reviewed' UDA date, or have not been reviewed for a week.
62 This means that if you run a review session to completion, there
64 will be no need to review again for a week, and the review com‐
65 mand will simply do nothing until then.
66 The one week review cycle is defined by the '_reviewed' custom
68 report, which can be modified if you prefer a monthly review
69 cycle.
70 If 'N' is provided, the session is limited to reviewing only N
72 tasks.
73 Note: requires Taskwarrior 2.5.0 or later. For full details,
75 see: <https://taskwarrior.org/docs/review.html>
76
79 Here is an example tasksh session.
80 $ tasksh
82 task> projects
83 Project Tasks Pri:None Pri:L Pri:M Pri:H
85 ------- ----- -------- ----- ----- -----
86 7 7 0 0 0
87 home 2 2 0 0 0
88 party 6 3 0 0 3
89 3 projects (15 tasks)
91 task> tags
92 Tag Count
94 mall 2
95 1 tag (15 tasks)
97 task> list
98 ID Project Pri Due Active Age Description
100 ---------------------------------------------------------------------
101 2 party H 10/17/2015 2 hrs Select and book a venue
102 5 party H 10/22/2015 2 hrs Design invitations
103 9 home 10/31/2015 1 hr Pay rent
104 3 party 2 hrs Mail invitations
105 4 party 2 hrs Select a caterer
106 6 party 2 hrs Print invitations
107 8 tasks
109 task> quit
110 $
111
114 Tasksh piggybacks on Taskwarrior's .taskrc configuration file, and
115 refers to settings there. If you use a non-standard location for your
116 .task database , and .taskrc file, Tasksh will not find them unless you
117 set the TASKDATA and TASKRC environment variables. See 'man taskrc' for
118 more details.
119 The review command storeѕ a UDA ('reviewed') and report definition
121 ('_reviewed').
122 tasksh.autoclear=1
125 If set to "1", causes each tasksh command to be preceded by a
126 'clear screen' and cursor reset. Default is "0".
127
130 Copyright (C) 2006 - 2017 P. Beckingham, F. Hernandez.
131 This man page was originally written by Federico Hernandez.
133 Tasksh is distributed under the MIT license. See http://www.open‐
135 source.org/licenses/mit-license.php for more information.
136
139 task(1),
140 For more information regarding tasksh, see the following:
142 The official site at
145 <http://taskwarrior.org/tools>
146 The official code repository at
149 <https://git.tasktools.org/scm/ex/tasksh.git>
150 You can contact the project by emailing
153 <support@tasktools.org>
154
157 Bugs in tasksh may be reported to the issue-tracker at
158 <http://bug.tasktools.org>
159tasksh 1.2.0 2017-05-10 tasksh(1)