NAME¶taskrc - Configuration details for the task(1) command
task rc:<directory-path>/.taskrc ...
TASKRC=<directory-path>/.taskrc task ...
DESCRIPTION¶Taskwarrior obtains its configuration data from a file called .taskrc . This file is normally located in the user's home directory:
The default location can be overridden using the rc: attribute when running task:
or using the TASKRC environment variable:
Individual options can be overridden by using the rc.<name>: attribute when running task:
If Taskwarrior is run without an existing configuration file it will ask if it should create a default, sample .taskrc file in the user's home directory.
The .taskrc file follows a very simply syntax defining name/value pairs:
There may be whitespace around <name>, '=' and <value>, and it is ignored. Whitespace within the <value> is left intact. Whitespace is not permitted in comma-separated lists. The entry must be on a single line, no continuations. Values support UTF8 as well as JSON encoding, such as \uNNNN.
Note that Taskwarrior is flexible about the values used to represent Boolean items. You can use "on", "yes", "y", "1" and "true". Anything else means "off".
There may be whitespace around 'include' and <file>. The file may be an absolute or relative path, and the special character '~' is expanded to mean $HOME. The entry must be on a single line, no continuations.
A comment consists of the character '#', and extends from the '#' to the end of the line. There is no way to comment a multi-line block. There may be blank lines.
Almost every value has a default setting, and an empty .taskrc file is one that makes use of every default. The contents of the .taskrc file therefore represent overrides of the default values. To remove a default value completely there must be an entry like this:
This entry overrides the default value with a blank value.
EDITING¶You can edit your .taskrc file by hand if you wish, or you can use the 'config' command. To permanently set a value in your .taskrc file, use this command:
To delete an entry, use this command:
Taskwarrior will then use the default value. To explicitly set a value to blank, and therefore avoid using the default value, use this command:
Taskwarrior will also display all your settings with this command:
and in addition, will also perform a check of all the values in the file, warning you of anything it finds amiss.
NESTING CONFIGURATION FILES¶The .taskrc can include other files containing configuration settings by using the include statement:
By using include files you can divide your main configuration file into several ones containing just the relevant configuration data like colors, etc.
There are two excellent uses of includes in your .taskrc, shown here:
This includes two standard files that are distributed with Taskwarrior, which define a set of US holidays, and set up a 16-color theme to use, to color the reports and calendar.
ENVIRONMENT VARIABLES¶These environment variables override defaults and command line arguments.
- This overrides the default path for the Taskwarrior data files.
- This overrides the default RC file.
CONFIGURATION VARIABLES¶Valid variable names and their default values are:
- This is a path to the directory containing all the Taskwarrior files. By
default, it is set up to be ~/.task, for example: /home/paul/.task
Note that you can use the ~ shell meta character, which will be properly expanded.
Note that the TASKDATA environment variable overrides this setting.
- Determines whether to use file locking when accessing the pending.data and completed.data files. Defaults to "on". Solaris users who store the data files on an NFS mount may need to set locking to "off". Note that there is danger in setting this value to "off" - another program (or another instance of task) may write to the task.pending file at the same time.
- Can be used to temporarily suspend garbage collection (gc), so that task IDs don't change. Note that this should be used in the form of a command line override (task rc.gc=off ...), and not permanently used in the .taskrc file, as this significantly affects performance in the long term.
- This master control switch enables hook script processing. The default value is 'on', but certain extensions and environments may need to disable hooks.
- When set to 'yes' causes the program to exit if the database (~/.task or rc.data.location or TASKDATA override) is missing. Default value is 'no'.
- Determines whether to use ioctl to establish the size of the window you are using, for text wrapping.
- The width of output used when auto-detection support is not available. Defaults to 80. If set to 0, it is interpreted as infinite width, therefore with no word-wrapping; this is useful when redirecting report output to a file for subsequent handling.
- The height of output used when auto-detection support is not available. Defaults to 24. If set to 0, it is interpreted as infinite height. This is useful when redirecting charts to a file for subsequent handling.
- Causes the width of the terminal minus one to be used as the full width. This avoids placing color codes in the last column which can cause problems for Cygwin users. Default value is 'no'.
- Hyphenates lines when wrapping breaks occur mid-word. Default value is 'on'.
- Specifies which text editor you wish to use for when the task edit <ID> command is used. Taskwarrior will first look for this configuration variable. If found, it is used. Otherwise it will look for the $VISUAL or $EDITOR environment variables, before it defaults to using "editor".
- This is the number of lines reserved at the bottom of the screen for the shell prompt. This is only referenced when 'limit:page' is used.
- When set to "on" (the default), helpful explanatory comments are
added to all output from Taskwarrior. Setting this to "off"
means that you would see regular output.
The special value "nothing" can be used to eliminate all optional output, which results in only the formatted data being shown, with nothing else. This output is most readily parsed and used by shell scripts.
Alternatively, you can specify a comma-separated list of verbosity tokens that control specific occasions when output is generated. This list may contain:
blank Inserts extra blank lines in output, for clarity header Messages that appear before report output footnote Messages that appear after report output label Column labels on tabular reports new-id Provides feedback of any new task IDs new-uuid Provides feedback of any new task UUIDs. Deprecated, to be merged with new-id. affected Reports 'N tasks affected' and similar edit Used the verbose template for the 'edit' command special Feedback when applying special tags project Feedback about project status changes sync Feedback about sync filter Shows the filter used in the command unwait Notification when a task leaves the 'waiting' state recur Notification when a new recurring task instance is created
"affected", "new-id", "new-uuid" "project" and "unwait" imply "footnote".
Note that the "on" setting is equivalent to all the tokens being specified, and the "nothing" setting is equivalent to none of the tokens being specified.
Here are the shortcut equivalents:
Those additional comments are sent to the standard error for header, footnote and project. The others are sent to standard output.
- May be "yes" or "no", and determines whether Taskwarrior will ask for confirmation before deleting a task or performing the undo command. The default value is "yes". Consider leaving this setting as "yes", for safety.
- An empty filter combined with a write command is potentially a way to modify all tasks by mistake, and when this is detected, confirmation is required. Setting this to 'no' means that it is an error to use a write command with no filter.
- Controls the number of spaces to indent annotations when shown beneath the description field. The default value is "2".
- Controls the indentation of the entire report output. Default is "0".
- Controls left and right padding around each row of the report output. Default is "0".
- Controls padding between columns of the report output. Default is "1".
- Is a number, defaulting to 3. When this number or greater of tasks are
modified in a single command, confirmation will be required, regardless of
the value of confirmation variable. The special value bulk=0 is
treated as an infinity.
This is useful for preventing large-scale unintended changes.
- nag=You have more urgent tasks.
- This may be a string of text, or blank. It is used as a prompt when a task is started of completed, when there are other tasks with a higher urgency. Default value is: 'You have more urgent tasks'. It is a gentle reminder that you are contradicting your own urgency settings.
- May be yes or no, and determines whether the 'projects' command lists all the project names you have used, or just the ones used in active tasks. The default value is "no".
- If set to yes, shows all projects in the summary report, even if there are no pending tasks. The default value is "no".
- May be yes or no, and determines whether the tab completion scripts consider all the tag names you have used, or just the ones used in active tasks. The default value is "no".
- May be yes or no, and determines whether the 'tags' command lists all the tag names you have used, or just the ones used in active tasks. The default value is "no".
- May be yes or no, and determines whether columns with no data for any task are printed. Defaults to no.
- May be yes or no, and determines whether keyword lookup and substitutions on the description and annotations are done in a case sensitive way. Defaults to yes on most platforms. Defaults to no on Cygwin due to older regex library problems with case-insensitivity.
- Controls whether regular expression support is enabled. The default value is on.
- Sets the xterm window title when reports are run. Defaults to off.
- Sets a preference for infix expressions (1 + 2) or postfix expressions (1 2 +). Defaults to infix.
- Determines whether the export command encloses the JSON output in '[...]' and adds ',' after each exported task object to create a properly-formed JSON array. With json.array=off, export writes raw JSON objects to STDOUT, one per line. Defaults to on.
- Determines whether the export command encodes dependencies as an array of string UUIDs, or one comma-separated string. Defaults to on.
- Taskwarrior shuts off color automatically when the output is not sent directly to a TTY. For example, this command:
will not use any color. To override this, use:
- The character or string to show in the start.active column. Defaults to *.
- The character or string to show in the tag.indicator column. Defaults to +.
- The character or string to show in the depends.indicator column. Defaults to +.
- The character or string to show in the <uda>.indicator column. Defaults to U.
- Controls whether recurrence is enabled, and whether recurring tasks continue to generate new task instances. Defaults to 'yes'.
- Controls whether changes to recurring tasks propagates to other child tasks with or without confirmation. A value of 'yes' means propagate changes without confirmation. A value of 'no' means do not propagate changes and don't ask for confirmation. A value of 'prompt' prompts you every time. Defaults to 'prompt'.
- The character or string to show in the recurrence_indicator column. Defaults to R.
- The number of future recurring tasks to show. Defaults to 1. For example, if a weekly recurring task is added with a due date of tomorrow, and recurrence.limit is set to 2, then a report will list 2 pending recurring tasks, one for tomorrow, and one for a week from tomorrow.
- When the 'undo' command is run, Taskwarrior presents a before and after comparison of the data. This can be in either the 'side' style, which compares values side-by-side in a table, or 'diff' style, which uses a format similar to the 'diff' command.
- Minimum length of any abbreviated command/value. This means that "ve", "ver", "vers", "versi", "versio" will all equate to "version", but "v" will not. Default is 2.
- Taskwarrior has a debug mode that causes diagnostic output to be
displayed. Typically this is not something anyone would want, but when
reporting a bug, debug output can be useful. It can also help explain how
the command line is being parsed, but the information is displayed in a
developer-friendly, not a user-friendly way.
Turning debug on automatically sets debug.hooks=1, debug.parser=1 and debug.tls=2 if they do not already have assigned values.
- Controls the hook system diagnostic level. Level 0 means no diagnostics. Level 1 shows hook calls. Level 2 also shows exit status and I/O.
- Controls the parser diagnostic level. Level 0 shows no diagnostics. Level 1 shows the final parse tree. Level 2 shows the parse tree from all phases of the parse. Level 3 shows expression evaluation details.
- Controls the GnuTLS diagnostic level. For 'sync' debugging. Level 0 means no diagnostics. Level 9 is the highest. Level 2 is a good setting for debugging.
- When set to '1', will replace all report text with 'xxx'. This is useful for sharing report output in bug reports. Default value is '0'.
- Taskwarrior supports command aliases. This alias provides an alternate name (rm) for the delete command. You can use aliases to provide alternate names for any of the commands. Several commands you may use are actually aliases - the 'history' report, for example, or 'export'.
- dateformat.edit=Y-M-D H:N:S
- dateformat.info=Y-M-D H:N:S
- This is a string of characters that defines how Taskwarrior formats date
values. The precedence order for the configuration variable is
report.X.dateformat then dateformat.report then dateformat for formatting
the due dates in reports. If both report.X.dateformat and
dateformat.report are not set then dateformat will be applied to the date.
Entered dates as well as all other displayed dates in reports are
formatted according to dateformat.
The default value is the ISO-8601 standard: Y-M-D. The string can contain the characters:
d minimal-digit day, for example 1 or 30
y two-digit year, for example 09 or 12
D two-digit day, for example 01 or 30
M two-digit month, for example 01 or 12
Y four-digit year, for example 2009 or 2015
a short name of weekday, for example Mon or Wed
A long name of weekday, for example Monday or Wednesday
b short name of month, for example Jan or Aug
B long name of month, for example January or August
v minimal-digit week, for example 3 or 37
V two-digit week, for example 03 or 37
h minimal-digit hour, for example 3 or 21
n minimal-digit minutes, for example 5 or 42
s minimal-digit seconds, for example 7 or 47
H two-digit hour, for example 03 or 21
N two-digit minutes, for example 05 or 42
S two-digit seconds, for example 07 or 47
J three-digit Julian day, for example 023 or 365
j Julian day, for example 23 or 365
d/m/Y would use for input and output 24/7/2009
yMD would use for input and output 090724
M-D-Y would use for input and output 07-24-2009
a D b Y (V) would emit "Fri 24 Jul 2009 (30)"
A, B D, Y would emit "Friday, July 24, 2009"
wV a Y-M-D would emit "w30 Fri 2009-07-24"
yMD.HN would emit "110124.2342"
m/d/Y H:N would emit "1/24/2011 10:42"
a D b Y H:N:S would emit "Mon 24 Jan 2011 11:19:42"
8/1/2013 with m/d/Y implies August 1, 2013 at midnight (inferred)
8/1 20:40 with m/d H:N implies August 1, 2013 (inferred) at 20:40
- Enables ISO-8601 date support. The default value is "yes".
- Determines the day a week starts. Valid values are Sunday or Monday only. The default value is "Sunday".
- Determines if week numbers are displayed when using the "task calendar" command. The week number is dependent on the day a week starts. The default value is "yes".
- This is the number of days into the future that define when a task is considered due, and is colored accordingly. The default value is 7.
- If set to full running "task calendar" will display the details of tasks with due dates that fall into the calendar period. The corresponding days will be color-coded in the calendar. If set to sparse only the corresponding days will be color coded and no details will be displayed. The displaying of due dates with details is turned off by setting the variable to none. The default value is "sparse".
- The report to run when displaying the details of tasks with due dates when running the "task calendar" command. The default value is "list".
- If "on" the first month in the calendar report is effectively changed by the offset value specified in calendar.offset.value. It defaults to "off".
- The offset value to apply to the first month in the calendar report. The default value is "-1".
- If set to full running "task calendar" will display holidays in the calendar by color-coding the corresponding days. A detailed list with the dates and names of the holidays is also shown. If set to sparse only the days are color-coded and no details on the holidays will be displayed. The displaying of holidays is turned off by setting the variable to none. The default value is "none".
- Determines whether the calendar legend is displayed. The default value is "yes".
- May be yes or no, and determines whether the 'start' and 'stop' commands should record an annotation when being executed. The default value is "no". The text of the corresponding annotations is controlled by:
- journal.time.start.annotation=Started task
- The text of the annotation that is recorded when executing the start command and having set journal.time.
- journal.time.stop.annotation=Stopped task
- The text of the annotation that is recorded when executing the stop command and having set journal.time.
- When enabled, this setting causes a change log of each task to be displayed by the 'info' command. Default value is "on".
HOLIDAYS¶Holidays are entered either directly in the .taskrc file or via an include file that is specified in .taskrc. For each holiday the name and the date is required to be given:
holiday.towel.name=Day of the towel
holiday.sysadmin.name=System Administrator Appreciation Day
Note that the Taskwarrior distribution contains example holiday files that can be included like this:
- Determines how many months the "task calendar" command renders across the screen. Defaults to however many will fit. If more months than will fit are specified, Taskwarrior will only show as many that will fit.
- Determines whether dependency chain violations generate reminders.
- Determines whether dependency chain repair requires confirmation.
- May be "on" or "off". Determines whether Taskwarrior uses color. When "off", will use dashes (-----) to underline column headings.
- Determines if font underlines or ASCII dashes should be used to underline headers, even when color is enabled.
Taskwarrior has a number of coloration rules. They correspond to a particular attribute of a task, such as it being due, or being active, and specifies the automatic coloring of that task. A list of valid colors, depending on your terminal, can be obtained by running the command:
color.active Task is started, therefore active.
color.scheduled Task is scheduled, therefore ready for work.
color.until Task has an expiration date.
color.blocking Task is blocking another in a dependency.
color.blocked Task is blocked by a dependency.
color.overdue Task is overdue (due some time prior to now).
color.due Task is coming due.
color.project.none Task does not have an assigned project.
color.tag.none Task has no tags.
color.tagged Task has at least one tag.
color.recurring Task is recurring.
color.completed Task is completed.
color.deleted Task is deleted.
However, color blending can produce highlighting combinations which are not desired. In such cases, use the following option to disable this behaviour:
- Can be "yes" or "no". When "no", disables
merging of colors produced by different color rules. Use if your color
scheme produces unpleasing foreground and background combinations.
See the task-color(5) man pages for color details.
Certain attributes like tags, projects and keywords can have their own coloration rules.
- Colors any task that has the tag X.
- color.project.X=on green
- Colors any task assigned to project X.
- color.keyword.X=on blue
- Colors any task where the description or any annotation contains X.
- color.uda.X=on green
- Colors any task that has the user defined attribute X.
- color.uda.X.VALUE=on green
- Colors any task that has the user defined attribute X set to VALUE.
- color.uda.X.none=on green
- Colors any task that does not have the user defined attribute X.
- color.error=white on red
- Colors any of the error messages.
- color.warning=bold red
- Colors any of the warning messages.
- Colors any of the messages printed prior to the report output.
- Colors any of the messages printed last.
- color.summary.bar=on green
- Colors the summary progress bar. Should consist of a background color.
- color.summary.background=on black
- Colors the summary progress bar. Should consist of a background color.
- color.calendar.today=black on cyan
- Color of today in calendar.
- color.calendar.due=black on green
- Color of days with due tasks in calendar.
- color.calendar.due.today=black on magenta
- Color of today with due tasks in calendar.
- color.calendar.overdue=black on red
- Color of days with overdue tasks in calendar.
- color.calendar.weekend=bright white on black
- Color of weekend days in calendar.
- color.calendar.holiday=black on bright yellow
- Color of holidays in calendar.
- color.calendar.weeknumber=black on white
- Color of weeknumbers in calendar.
- Colors the report labels. Defaults to not use color.
- Colors the report labels for sort columns. Defaults to color.label.
- color.alternate=on rgb253
- Color of alternate tasks. This is to apply a specific color to every other task in a report, which can make it easier to visually separate tasks. This is especially useful when tasks are displayed over multiple lines due to long descriptions or annotations.
- color.history.add=on red
- color.burndown.pending=on red
- due,scheduled,keyword.,project.,tag.,uda., recurring,tagged,completed,deleted
URGENCY¶The urgency calculation uses a polynomial with several terms, each of which has a configurable coefficient. Those coefficients are:
The coefficients reflect the relative importance of the various terms in the urgency calculation. These are default values, and may be modified to suit your preferences, but it is important that you carefully consider any modifications.
- Provides a default project name for the task add command, if you don't specify one. The default is blank.
- Provides a default due date for the task add command, if you don't specify one. You can use a date, or a duration value which is assumed to be relative to 'now'. The default is blank.
- Provides default values for UDA fields when using the task add command, if you don't specify values. The default is blank.
- Provides a default command that is run every time Taskwarrior is invoked with no arguments. For example, if set to:
[task project:foo list]
ID Project Pri Description 1 foo H Design foo 2 foo Build foo
REPORTS¶The reports can be customized by using the following configuration variables. The output columns, their labels and the sort order can be set using the corresponding variables for each report. Each report name is used as a "command" name. For example
- task overdue
- The description for report X when running the "task help" command.
- This is a comma-separated list of columns and formatting specifiers. See the command 'task columns' for a full list of options and examples.
- The labels for each column that will be used when generating report X. The labels are a comma separated list.
- The sort order of the tasks in the generated report X. The sort order is
specified by using the column ids post-fixed by a "+" for
ascending sort order or a "-" for descending sort order. The
sort IDs are separated by commas. For example:
Additionally, after the "+" or "-", there can be a solidus "/" which indicates that there are breaks after the column values change. For example:
This sort order now specifies that there is a listing break between each project. A listing break is simply a blank line, which provides a visual grouping.
A special sort value of "none" indicates that no sorting is required, and tasks will be presented in the order (if any) in which they are selected.
- This adds a filter to the report X so that only tasks matching the filter criteria are displayed in the generated report.
- This adds a dateformat to the report X that will be used by the "due date" column. If it is not set then dateformat.report and dateformat will be used in this order. See the DATES section for details on the sequence placeholders.
- This adds the possibility to control the output of annotations for a task in a report. Deprecated. Use the description column with a format (e.g., description.count) instead.
- Taskwarrior comes with a number of predefined reports, which are:
- Lists the most important tasks.
- Lists all pending tasks and all data, matching the specified criteria.
- Lists all tasks matching the specified criteria.
- Short listing of all tasks matching the specified criteria.
- Minimal listing of all tasks matching the specified criteria.
- Shows the newest tasks.
- Shows the oldest tasks.
- Lists overdue tasks matching the specified criteria.
- Lists active tasks matching the specified criteria.
- Lists completed tasks matching the specified criteria.
- Lists recurring tasks matching the specified criteria.
- Lists all waiting tasks matching the specified criteria.
- Lists all tasks matching the specified criteria.
- Lists all tasks that have dependencies.
USER DEFINED ATTRIBUTES¶User defined attributes (UDAs) are an extension mechanism that allows you to define new attributes for Taskwarrior to store and display. One such example is an 'estimate' attribute that could be used to store time estimates associated with a task. This 'estimate' attribute is not built in to Taskwarrior, but with a few simple configuration settings you can instruct Taskwarrior to store this item, and provide access to it for custom reports and filters.
This allows you to augment Taskwarrior to accommodate your workflow, or bend the rules and use Taskwarrior to store and synch data that is not necessarily task-related.
One important restriction is that because this is an open system that allows the definition of any new attribute, Taskwarrior cannot understand the meaning of that attribute. So while Taskwarrior will faithfully store, modify, report, sort and filter your UDA, it does not understand anything about it. For example if you define a UDA named 'estimate', Taskwarrior will not know that this value is weeks, hours, minutes, money, or some other resource count.
- uda.<name>.label=<column heading>
Note that the order of the value is important, and denotes the sort order from highest ('A') to lowest ('C').
Note that a blank value is permitted.
- Example 'estimate' UDA
- This example shows an 'estimate' UDA that stores specific values for the size of a task. Note the blank value after 'trivial'.
huge > large > medium > small > trivial > ''
CONTEXT¶Context setting is a mechanism which allows the user to set a permanent filter, thus avoiding the need to specify one filter repeatedly. More details on usage can be found in the task(1) man page.
The current context is stored in the .taskrc file, along with definitions for all user provided contexts.
SYNC¶These configuration settings are used to connect and sync tasks with the task server.
- taskd.trust=strict|ignore hostname|allow all
- Override of the cipher selection. The set of ciphers used by TLS may be controlled by both server and client. There must be some overlap between client and server supported ciphers, or communication cannot occur. Default is "NORMAL". See GnuTLS documentation for full details.
CREDITS & COPYRIGHTS¶Copyright (C) 2006 - 2016 P. Beckingham, F. Hernandez.
This man page was originally written by Federico Hernandez.
Taskwarrior is distributed under the MIT license. See http://www.opensource.org/licenses/mit-license.php for more information.
SEE ALSO¶task(1), task-color(5), task-sync(5)
For more information regarding Taskwarrior, see the following:
- Bugs in Taskwarrior may be reported to the issue-tracker at