|
1 | | -# gtt |
2 | | - |
3 | | -[](https://www.npmjs.com/package/gitlab-time-tracker) |
4 | | -[](https://www.npmjs.com/package/gitlab-time-tracker) |
| 1 | +# gtt [](https://www.npmjs.com/package/gitlab-time-tracker) [](https://www.npmjs.com/package/gitlab-time-tracker) |
5 | 2 |
|
6 | 3 | > A command line interface that makes working with GitLabs time tracking feature more enjoyable. |
7 | 4 |
|
8 | 5 | gtt monitors the time you spent on an issue or merge request locally and syncs it to GitLab. |
9 | 6 | It also allows you to create time tracking reports in various formats from time tracking data |
10 | 7 | stored on GitLab. |
11 | 8 |
|
12 | | - |
13 | | - |
14 | 9 | ## requirements |
15 | 10 |
|
16 | 11 | * [node.js](https://nodejs.org/en/download) version > 6 |
@@ -43,37 +38,12 @@ url: https://gitlab.com/api/v4/ |
43 | 38 | token: 01234567891011 |
44 | 39 | ``` |
45 | 40 |
|
46 | | -#### upgrading from 0.* |
47 | | - |
48 | | -I built gtt originally in PHP because I'm a PHP dev and I chose the language I'm most familiar |
49 | | -with to create a quick and dirty prototype. After some consideration I rebuilt everything from |
50 | | -scratch for node.js. Follow these steps to upgrade: |
51 | | - |
52 | | -``` |
53 | | -# 1. remove the old version entirely |
54 | | -composer global remove kriskbx/gitlab-time-tracker |
55 | | -
|
56 | | -# 2. install the new version |
57 | | -# using yarn |
58 | | -yarn global add gitlab-time-tracker --prefix /usr/local |
59 | | -
|
60 | | -# using npm |
61 | | -npm install -g gitlab-time-tracker |
62 | | -
|
63 | | -# 3. edit your configuration and update the date format |
64 | | -# format options: http://momentjs.com/docs/#/displaying/format/ |
65 | | -gtt edit |
66 | | -
|
67 | | -# 4. the columns option is now split into 3 options for different parts of |
68 | | -# the report: issueColumns, mergeRequestColumns and recordColumns |
69 | | -# there's also a userColumns option that adds a column for each user |
70 | | -# with total time spent. please update your config accordingly |
71 | | -``` |
72 | | - |
73 | 41 | ## commands |
74 | 42 |
|
75 | 43 | #### time tracking |
76 | 44 |
|
| 45 | + |
| 46 | + |
77 | 47 | Time tracking enables you to track and monitor your time locally. When you're done, |
78 | 48 | you can sync time records to GitLab and create "time spent comments" automatically. |
79 | 49 |
|
|
0 commit comments