taskd(1) - f29

1taskd(1)                         User Manuals                         taskd(1)
2
3
4

NAME

6       taskd - Taskserver
7
8

SYNOPSIS

10       taskd <command> [options] [<args>]
11       taskd -v|--version
12       taskd -h|--help
13       taskd diagnostics
14       taskd validate <JSON | file>
15       taskd help [<command>]
16
17

DESCRIPTION

19       Taskserver is a sync server for Taskwarrior and related products.
20
21

COMMANDS

23       Taskserver  supports  several  commands,  which  provide administrative
24       capabilities.  The commands are:
25
26
27       taskd init [--data <root>] [options]
28              Performs a one-time initialization of the  Taskserver  instance.
29              Creates the bare data structure.  Either '--data <root>' must be
30              specified, or TASKDDATA must be set.
31
32
33       taskd help <command> [options]
34              Provides option and syntax help for each command.
35
36
37       taskd config [options] [--data <root>] [--force] [<name> [<value>]]
38              Allows  modification  of  the  taskd  configuration.   Can  add,
39              remove,  modify  or  list  all  configuration  settings.  Either
40              '--data <root>' must be specified, or TASKDDATA must be set.
41
42
43       taskd server [--daemon] [options]
44              Starts the server in daemon or TTY  mode.   While  there  is  no
45              interactivity,  the difference is whether taskd is attached to a
46              TTY or not.
47
48              Note that sending the HUP signal to the taskd  server  causes  a
49              configuration file reload before the next request is handled.
50
51
52       taskd add [--data <root>] org <org>
53
54       taskd add [--data <root>] group <org> <group>
55
56       taskd add [--data <root>] user <org> <user>
57              Adds  organizations,  groups  and users.  Either '--data <root>'
58              must be specified, or TASKDDATA must be set.
59
60
61       taskd remove [--data <root>] org <org>
62
63       taskd remove [--data <root>] group <org> <group>
64
65       taskd remove [--data <root>] user <org> <user>
66              Removes organizations, groups and users.  Either '--data <root>'
67              must be specified, or TASKDDATA must be set.
68
69
70       taskd suspend [--data <root>] org <org>
71
72       taskd suspend [--data <root>] group <org> <group>
73
74       taskd suspend [--data <root>] user <org> <user>
75              Suspends   organizations,  groups  and  users.   Either  '--data
76              <root>' must be specified, or TASKDDATA must be set.
77
78
79       taskd resume [--data <root>] org <org>
80
81       taskd resume [--data <root>] group <org> <group>
82
83       taskd resume [--data <root>] user <org> <user>
84              Resumes organizations, groups and users.  Either '--data <root>'
85              must be specified, or TASKDDATA must be set.
86
87
88       taskd diagnostics
89              Displays diagnostic information important when reporting bugs.
90
91
92       taskd validate <JSON | file>
93              Parses  the  quoted JSON string or JSON file.  Useful for debug‐
94              ging JSON that is generated by Taskserver clients.
95
96
97       taskd client [options] <host:port> <file> [<file> ...]
98              Sends the Taskserver request in <file> to  <host:port>.  Options
99              specified   must   include   ca.cert  (for  self-signed  certs),
100              client.cert, client.key.
101
102

COMMON OPTIONS

104       Most commands support the following options:
105
106
107       --NAME=VALUE
108              Temporary configuration override.
109
110
111       --force
112              Does not ask for confirmation of changes.
113
114
115       --quiet
116              Suppresses verbose output.
117
118
119       --debug
120              Shows debugging information.
121
122
123       --data <root>
124              Many commands require the location of the data root,  so  either
125              it  must  be provided as shown, or via the TASKDDATA environment
126              variable.
127
128

CONFIGURATION

130       The Taskserver configuration file can be found in the top level of  the
131       data  root.   It is recommended that the 'taskd config' command is used
132       to manipulate this file.
133
134       Note that any configuration variable may be overridden on  the  command
135       line using this syntax:
136
137         $ taskd server --NAME=VALUE
138
139       In  all  commands  but one, this will _temporarily_ override the value,
140       but with the 'init' command, which creates a config file, overrides are
141       made permanent.
142
143

ENVIRONMENT VARIABLES

145       Environment  variables  provide values that would otherwise be required
146       at the command line.
147
148
149       TASKDDATA=<root>
150              Most command require either '--data <root>' or this  environment
151              variable.   If both are provided, the command line overrides the
152              environment.
153
154

CREDITS & COPYRIGHTS

156       Copyright (C) 2010 - 2015, Göteborg Bit Factory.
157
158       Taskserver is distributed under the MIT license.  See  http://www.open‐
159       source.org/licenses/mit-license.php for more information.
160
161

REPORTING BUGS

181       Bugs in Taskserver may be reported to the issue-tracker at
182              <http://taskwarrior.org
183
184
185
186
187taskd 1.1.0                       2015-05-10                          taskd(1)