forked from telmich/ctt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ctt.text
147 lines (107 loc) · 3.49 KB
/
ctt.text
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
ctt(1)
======
Nico Schottelius <nico-ctt--@--schottelius.org>
NAME
----
ctt - time tracking for geeks
SYNOPSIS
--------
ctt [-h] [-d] [-v] {listprojects,track,report} ...
ctt listprojects [-h] [-d] [-v]
ctt track [-h] [-d] [-v] [-s START] [-e END] [-n] project
ctt report [-h] [-d] [-v] [--sd START] [--ed END] [-e REGEXP] [-i]
[-f OUTPUT_FORMAT]
project
DESCRIPTION
-----------
ctt tracks time while you are working and stores the values
in a cconfig database.
GENERAL OPTIONS
---------------
The following parameters are available to all subcommands:
-h, --help::
show this help message and exit
-d, --debug::
set log level to debug
-v, --verbose::
set log level to info, be more verbose
TRACK
-----
Tracking is started by using the **track** subcommand.
It requires the project name to track time for.
Without any options it stays in the foreground and waits until
enter is pressed and then prompts for a comment.
Available parameters:
--sd START, --start START::
start date (default: first of this month, format: Y-m-d)
--ed END, --end END::
end date (default: last of this month, format: Y-m-d)
-n, --no-comment::
disable comment prompting after tracking
REPORT
------
Reporting is handled by the **report** subcommand.
It requires the project name to report time for.
It supports to filter entries using regular expressions
and also allows to use a custom output format.
Available parameters:
--sd START, --start START::
start date (default: first of this month, format: Y-m-d)
--ed END, --end END::
end date (default: last of this month, format: Y-m-d)
-e REGEXP, --regexp REGEXP::
regular expression to match
-i, --ignore-case::
ignore case distinctions
-f OUTPUT_FORMAT, --format OUTPUT_FORMAT::
output format (default: {start_datetime} ({delta}): {comment})
Output format may reference the following fields:
- start_datetime
- end_datetime
- delta
- delta_seconds
- delta_minutes
- comment
LISTPROJECTS
------------
The **listprojects** subcommand is used to list used projects.
It does not expect any parameters.
EXAMPLES
--------
--------------------------------------------------------------------------------
# Track some time
% ctt track test
Comment: Did some cool work
# Track for a given time range
% ctt track --sd 2013-04-29-1000 --ed 2013-05-29-1200 test
Comment: Long working period
# Track (keep running), but specify different start date
% ctt track --sd 2013-04-29-0800 test
Comment: Started early today
# Track without prompting for a comment
% ctt track -n test
# List available projects
% ctt listprojects
[...]
# List all entries of this month for project test
% ctt report test
[...]
# List all entries from January
% ctt report --sd 2013-01-01 --ed 2013-01-31 test
# List all entries from January matching either rails ruby or cdist
% ctt report --sd 2013-01-29 --ed 2013-04-29 -e "(rails|ruby|cdist)" test
# The same, but case insensitive
% ctt report --sd 2013-01-29 --ed 2013-04-29 -e "(rails|ruby|cdist)" -i test
--------------------------------------------------------------------------------
BUGS
----
ctt is made for geeks, so it should not stand in your way.
If it does, raise a bug.
SEE ALSO
---------
- cconfig homepage: http://www.nico.schottelius.org/docs/cconfig/
- ctt homepage: http://www.nico.schottelius.org/software/ctt/
COPYING
-------
Copyright \(C) 2013 Nico Schottelius. Free use of this software is
granted under the terms of the GNU General Public License version 3 (GPLv3).