1 .TH tasksh 1 2017-05-10 "${PACKAGE_STRING}" "User Manuals"
4 tasksh \- Interactive taskwarrior shell
12 Tasksh can be used to create a more immersive taskwarrior environment.
13 Any task command you run outside the shell can also be run inside
14 the shell, without the need to prefix every command with "task".
16 When built with libreadline, tasksh provides command editing and history.
18 Tasksh has an integrated 'review' command that leads you through an interactive
21 Tasksh supports all recent versions of Taskwarrior.
24 Tasksh supports the following commands. All other commands are passed intact to
29 Displays settings pertinent to tasksh, for diagnosing problems.
33 This command allows you to run shell commands from within Tasksh. This is ideal
34 for accessing man pages such as this. The '!' command can be used in place of
35 the 'exec' keyword. Once the command is run, control returns to Tasksh.
39 These commands cause tasksh to terminate, returning you to your system shell.
43 Shows a summary of commands, and how to obtain help.
47 Begins an interactive review session, where you can mark tasks as reviewed,
48 edit them using your text editor, provide modification commands, or skip them.
49 You can terminate a review session at any time, and the next review session
50 will resume at the right place.
52 To find tasks needing review, the '_reviewed' custom report is created and run,
53 which filters tasks that have a missing 'reviewed' UDA date, or have not been
56 This means that if you run a review session to completion, there will be no
57 need to review again for a week, and the review command will simply do nothing
60 The one week review cycle is defined by the '_reviewed' custom report, which
61 can be modified if you prefer a monthly review cycle.
63 If 'N' is provided, the session is limited to reviewing only N tasks.
65 Note: requires Taskwarrior 2.5.0 or later.
66 For full details, see:
67 <https://taskwarrior.org/docs/review.html>
70 Here is an example tasksh session.
78 Project Tasks Pri:None Pri:L Pri:M Pri:H
80 ------- ----- -------- ----- ----- -----
108 ID Project Pri Due Active Age Description
110 ---------------------------------------------------------------------
112 2 party H 10/17/2015 2 hrs Select and book a venue
114 5 party H 10/22/2015 2 hrs Design invitations
116 9 home 10/31/2015 1 hr Pay rent
118 3 party 2 hrs Mail invitations
120 4 party 2 hrs Select a caterer
122 6 party 2 hrs Print invitations
134 Tasksh piggybacks on Taskwarrior's .taskrc configuration file, and refers
135 to settings there. If you use a non-standard location for your .task database
136 , and .taskrc file, Tasksh will not find them unless you set the TASKDATA and
137 TASKRC environment variables. See 'man taskrc' for more details.
139 The review command storeѕ a UDA ('reviewed') and report definition ('_reviewed').
142 .B tasksh.autoclear=1
143 If set to "1", causes each tasksh command to be preceded by a 'clear screen' and
144 cursor reset. Default is "0".
146 .SH "CREDITS & COPYRIGHTS"
147 Copyright (C) 2006 \- 2017 P. Beckingham, F. Hernandez.
149 This man page was originally written by Federico Hernandez.
151 Tasksh is distributed under the MIT license. See
152 http://www.opensource.org/licenses/mit-license.php for more information.
157 For more information regarding tasksh, see the following:
161 <http://taskwarrior.org/tools>
164 The official code repository at
165 <https://git.tasktools.org/scm/ex/tasksh.git>
168 You can contact the project by emailing
169 <support@tasktools.org>
173 Bugs in tasksh may be reported to the issue-tracker at
174 <http://bug.tasktools.org>