-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathHELP.txt
executable file
·191 lines (115 loc) · 4.82 KB
/
HELP.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
--| taskman v0.3 by Pavel Kabir |--
--> Syntax: taskman [operation] [flags] [args]
--> Operations:
--> to show this help text:
taskman (/?|--help|help)
--> to add a new task:
taskman (add|new) [flags] description
> use flags to specify a task's priority or a due date.
> ID will be assigned to a task automatically.
--> to update task parameters:
taskman (update|change|modify|set) [flags] parameter args
> use flags to filter the tasks to be updated.
> if 'parameter' is 'description',
then 'args' will be concatenated into the new description.
> if 'parameter' is 'importance' or 'priority',
then 'args' should be a number from 1 to 3, or the
priority's text value (e.g. 'Normal').
> if 'parameter' is 'finished'/'completed'/'accomplished',
then 'args' should be '0', 'false', '1', or 'true'.
> if 'parameter' is 'duedate'/'due',
then 'args' should be the due date representation.
--> to show tasks:
taskman (show|display) [flags]
> use flags to filter the tasks to be displayed
or specify the task display order.
--> to complete tasks:
taskman (finish|complete|accomplish) [flags]
> use flags to filter the tasks to be marked as finished.
--> to reopen tasks:
taskman (reopen|unfinish|uncomplete) [flags]
> use flags to filter the tasks to be reopened.
--> to renumber tasks:
taskman renumber [--orderby sortorder]
> renumbers the tasks, assigning them new zero-based IDs
in the order of display.
> use an --orderby flag to override the sorting order
defined in the configuration file.
--> to remove a task:
taskman (delete|remove) [flags]
> use flags to filter the tasks to be deleted.
> there is a 'clear' alias that removes
all tasks interactively.
--> to configure program parameters:
taskman config [param] [--global|--default] [value]
> raw 'config' displays a list of available
parameters along with their current values.
> 'config param' displays the current value of
the parameter along with its default value
> 'config param value' assigns the provided value to
the specified parameter
> use --global flag to configure the parameter
globally and not just for the current user.
> use --default flag to reset a parameter
to its default value.
--> to view / switch the current task list:
taskman list [name]
> raw 'list' displays the current list name
along with the available non-empty task lists.
> no empty lists are displayed because the list
files are deleted as soon as they become empty.
> specifying a name argument will change the
currently used list. no spaces are allowed.
--> not to type 'taskman' each time:
taskman (repl|shell)
> enters a looped read-eval-print mode
continuously listening to new commands.
> 'repl' and 'shell' are meta-commands
that are unavailable when already in REPL
mode, so Leo would be disappointed.
> to exit REPL mode, type 'quit' or 'exit'.
> to clear screen in the shell mode, type 'cls'.
--> available command line options:
{0}
--> detailed discussion of some options:
--id
> you can specify a list of comma-separated id's
like '1,2,10'.
> alternatively, you can specify a range of id's
like '5-20'.
--orderby
> the tasks exhibit the following properties that
you can order by: 'id', 'isfinished', 'duedate',
'description', and 'priority'.
> the value of the --orderby option should be a
sequence of task properties, followed by a '+'
(sort ascending) or a '-' (sort descending).
> you can specify only a part of a property name
as long as it does not produce ambiguity.
> for example, --orderby pr+is+desc- will first
sort tasks ascending by priority, then ascending
by being finished, and then descending by description.
--duedate
> there are three ways to specify a task due date -
absolute, relative, and using natural language.
> using absolute syntax, just specify a string that
can be parsed into a datetime, like '21 Jan 2025'
or '2025-01-21'.
> relative syntax adds a given number of years,
months, weeks or days to a given date.
* for example, '+2m-2d' will add two months
and subtract two days relative to today.
* '2025-01-21::+2w' will add two weeks to
21 January 2025.
> natural language syntax supports 'today',
'tomorrow', 'this/next monday..sunday', and
'this/next week/month/year'.
--> example usages:
> taskman add remember the milk --priority critical --due tomorrow
> taskman add pay bills --due 'this month' --list household
> taskman show --like milk --orderby isfinished+desc-
> taskman show --skip 100 --limit 10
> taskman config sortorder priority+id+
> taskman set --id 1,2,10 priority Important
> taskman reopen --like 'change tires'
> taskman delete --all --interactive