10 |
11 | Git Time Metrics (GTM) is a tool to automatically track time spent reading and working on code that you store in a Git repository.
12 | By installing GTM and using supported plug-ins for your favorite editors, you can immediately realize better insight into how you are spending your time and on what files.
13 |
14 | Installation
15 |
16 | Installing GTM is a two step process. First, it's recommended you install the GTM executable that the plug-in integrates with and then install the JetBrains GTM plug-in. Please submit an issue if you have any problems and/or questions.
17 |
18 | 1. Follow the Getting Started section to install the GTM executable for your operating system.
19 |
20 | 2. Install the plug-in from your JetBrains IDE, select Preferences -> Plugins -> Browse Repositories... and search for "Git Time Metric".
21 |
22 |
23 | Note - to enable time tracking for a Git repository, you need to initialize it with gtm init otherwise it will be ignored by GTM. This is done via the command line. You can run this within the JetBrains IDE terminal.
3 |
4 | ### JetBrains Git Time Metrics (GTM) plug-in
5 |
6 | #### IntelliJ IDEA, PyCharm, WebStorm, AppCode, RubyMine, PhpStorm, AndroidStudio Plug-ins
7 |
8 | #### Simple, seamless, lightweight time tracking for all your git projects
9 |
10 | Git Time Metrics (GTM) is a tool to automatically track time spent reading and working on code that you store in a Git repository. By installing GTM and using supported plug-ins for your favorite editors, you can immediately realize better insight into how you are spending your time and on what files.
11 |
12 | # Installation
13 |
14 | Installing GTM is a two step process. First, it's recommended you install the GTM executable that the plug-in integrates with and then install the JetBrains GTM plug-in. Please submit an issue if you have any problems and/or questions.
15 |
16 | 1. Follow the [Getting Started](https://github.com/git-time-metric/gtm/blob/master/README.md) section to install the GTM executable for your operating system. This plug-in looks for the gtm executable in the following locations:
17 |
23 | 2. Install the plug-in from your JetBrains IDE, select `Preferences` -> `Plugins` -> `Browse Repositories...` and search for `Git Time Metric`.
24 |
25 | **Note** - to enable time tracking for a Git repository, you need to initialize it with `gtm init` otherwise it will be ignored by GTM. This is done via the command line. You can run this within the JetBrains IDE terminal.
26 | ```
27 | > cd /path/to/your/project
28 | > gtm init
29 | ```
30 |
31 | Consult the [README](https://github.com/git-time-metric/gtm/blob/master/README.md) and [Wiki](https://github.com/git-time-metric/gtm/wiki) for more information.
32 |
33 | # Features
34 |
35 | ### Status Bar
36 |
37 | In the status bar see your total time spent for in-process work (uncommitted).
38 |
39 | 
40 |
41 | **Note** - the time shown is based on the file's path and the Git repository it belongs to. You can have several files open that belong to different Git repositories. The status bar will display the time for the current file's Git repository. Also keep in mind, a Git repository must be initialized for time tracking in order to track time.
42 |
43 | ### Command Line Interface
44 |
45 | Use the command line to report on time logged for your commits.
46 |
47 | Here are some examples of insights GTM can provide you.
48 |
49 | ##### $ gtm report -last-month
50 |