Estimate the amount of time spent working on a Git repository

Last update: Nov 16, 2022

Related tags

Overview

jikyuu (時給)

A tool to estimate the amount of time spent working on a Git repository.

It is a direct port of git-hours, written in Node.js, because the code was many years out of date and no longer builds.

Note that the information provided is only a rough estimate.

Installation

cargo install jikyuu

Example

git clone https://github.com/twbs/bootstrap
cd bootstrap
jikyuu

+----------------+-------------------------+---------+-----------------+
| Author         | Email                   | Commits | Estimated Hours |
|                |                         |         |                 |
| Mark Otto      | [email protected]     | 2902    | 1808.9833       |
| Mark Otto      | [email protected]         | 2516    | 1709.4          |
| XhmikosR       | [email protected]      | 1431    | 1612.4667       |
| Chris Rebert   | [email protected]       | 945     | 1019.3          |
| Jacob Thornton | [email protected] | 826     | 740.35          |
| Mark Otto      | [email protected]    | 858     | 663.7167        |
| <...>          |                         |         |                 |
|                |                         |         |                 |
| Total          |                         | 16639   | 15041.153       |
+----------------+-------------------------+---------+-----------------+

You can associate an author that has used multiple emails in the commit logs with the --email (-e) option.

jikyuu -e [email protected][email protected] \
       -e [email protected][email protected] \
       -e [email protected][email protected] \
       -e [email protected][email protected]

+-----------------+---------------------------+---------+-----------------+
| Author          | Email                     | Commits | Estimated Hours |
|                 |                           |         |                 |
| Mark Otto       | [email protected]       | 6880    | 4662.817        |
| XhmikosR        | [email protected]        | 1431    | 1612.4667       |
| Chris Rebert    | [email protected]         | 945     | 1019.3          |
| Jacob Thornton  | [email protected]   | 826     | 740.35          |
| Martijn Cuppens | [email protected] | 361     | 508.5           |
| <...>           |                           |         |                 |
+-----------------+---------------------------+---------+-----------------+

Use --format json (-f) to output the data as a JSON array.

[
  {
    "email": "[email protected]",
    "author_name": "Mark Otto",
    "hours": 4662.817,
    "commit_count": 6880
  },
  {
    "email": "[email protected]",
    "author_name": "XhmikosR",
    "hours": 1612.4667,
    "commit_count": 1431
  },

  // ...

  {
    "email": null,
    "author_name": "Total",
    "hours": 14826.803,
    "commit_count": 16639
  }
]

Algorithm

See the How it works section of the git-hours README.

Usage

Run the following command to estimate the time spent for the provided Git repository.

jikyuu /path/to/git/repo/

The path must point to the root of the Git repo, not any subdirectories inside of it.

Extended usage:

USAGE:
    jikyuu [FLAGS] [OPTIONS] 

FLAGS:
    -h, --help              Prints help information
    -m, --merge-requests    Include merge requests into calculation
    -V, --version           Prints version information

OPTIONS:
    -b, --branch                                                 Analyze only data on the specified branch
    -t, --branch-type 
            Type of branch that `branch` refers to. `local` means refs/heads/, `remote` means refs/remotes/.

    -e, --email ...
            Associate all commits that have a secondary email with a primary email

    -a, --first-commit-add 
            How many minutes first commit of session should add to total [default: 120]

    -f, --format 
             [default: stdout]  [possible values: Stdout, Json]

    -d, --max-commit-diff 
            Maximum difference in minutes between commits counted to one session [default: 120]

    -s, --since 
            Analyze data since certain date [default: always]

    -u, --until 
            Analyze data until certain date [default: always]


ARGS:
        Root path of the Git repository to analyze.

License

MIT.

You might also like...

Stacked branch management for Git

git-stack Stacked branch management for Git Dual-licensed under MIT or Apache 2.0 Documentation About Installation Getting Started Reference FAQ Compa

1 Jul 18, 2022

Lintje is an opinionated linter for Git.

Lintje Lintje is an opinionated linter for Git. It lints commit messages based on a preconfigured set of rules focussed on promoting communication bet

26 Dec 18, 2022

Replay git history with some tweaks

Git-replay Overview Git-replay is a simple tool that replays the history of a Git repository but with some tweaks (i.e., it can change the author name

3 Mar 22, 2022

A git hook to manage derivative files automatically.

git-derivative A git hook to manage derivative files automatically. For example if you checked out to a branch with different yarn.lock, git-derivativ

3 Oct 30, 2022

Simple and fast git helper functions

126 Dec 11, 2022

Verbump - A simple utility written in rust to bump and manage git semantic version tags.

6 May 6, 2022

A git prepare-commit-msg hook for authoring commit messages with GPT-3.

gptcommit A git prepare-commit-msg hook for authoring commit messages with GPT-3. With this tool, you can easily generate clear, comprehensive and des

3 Jan 19, 2023

Original Version Management System based on Git

nss (noshishi) Original Version Management System based on Git. Learning git and rust for good developer. Usage Install cargo install nssi how to nss

4 Feb 13, 2023

Easily add emojis to your git commit messages 😎

gimoji A CLI tool that makes it easy to add emojis to your git commit messages. It's very similar to (and is based on) gitmoji-cli but written in Rust

12 May 29, 2023

Comments

inconsistency between js and rust implementation's output

Hey @Ruin0x11 thank you for this great work of re-implementing git-hours in Rust. Very much needed! I was looking forward for a fresh implementation of this great tool.

Today I decided to give it a shot and test a bit and I found something odd. For instance, if we consider the repo https://github.com/grinfans/grinmw.py commit a08ccdecf0945d3a980c6e2c9495b747f9b7cfc3 and run both of them with same same --max-commit-diff numbers I find much different results

jikyuu

$ jikyuu -d 120 -f json
[
  {
    "email": "[email protected]",
    "author_name": "xiaojay",
    "hours": 4.2,
    "commit_count": 10
  },
  {
    "email": "[email protected]",
    "author_name": "Blade Doyle",
    "hours": 1.05,
    "commit_count": 5
  },
  {
    "email": "[email protected]",
    "author_name": "marekyggdrasil",
    "hours": 0.36666667,
    "commit_count": 4
  },
  {
    "email": "[email protected]",
    "author_name": "ndcroos",
    "hours": 0.0,
    "commit_count": 1
  },
  {
    "email": null,
    "author_name": "Total",
    "hours": 5.616667,
    "commit_count": 20
  }
]

git-hours

$ git-hours -d 120
{
  "[email protected]": {
    "name": "marekyggdrasil",
    "hours": 0,
    "commits": 4
  },
  "[email protected]": {
    "name": "ndcroos",
    "hours": 0,
    "commits": 1
  },
  "[email protected]": {
    "name": "Blade Doyle",
    "hours": 4,
    "commits": 5
  },
  "[email protected]": {
    "name": "xiaojay",
    "hours": 18,
    "commits": 14
  },
  "total": {
    "hours": 22,
    "commits": 24
  }
}

The total is far off! The Blade Doyle five commits are estimated by jikyuu to take 1.05 hours and according to git-hours they took 4 hours.

Not saying your result is wrong. I think we should estimate which of the implementations is right!

opened by marekyggdrasil 6

calculating daily work time

@Ruin0x11 following up on the feature suggestion https://github.com/Ruin0x11/jikyuu/issues/2

Please note this is a work-in-progress, more commits are going to be added to this PR. Another disclaimer is, this is my first Rust code ever so please be gentle with the review ;P.

opened by marekyggdrasil 4

feature idea: daily working hours

I have an idea for a feature. I wanted to contribute it to git-hours but I was not able to build the dev mode (only install from npm).

Idea is providing number of hours on each day, for example:

[
  {
    "email": "[email protected]",
    "author_name": "John Doe",
    "hours": 12.817,
    "commit_count": 14,
    "breakdown": {
        "2021-04-27": 6.817,
        "2021-04-26": 6.0
    }
  },
  {
    "email": "[email protected]",
    "author_name": "Alice Bob",
    "hours": 21.4667,
    "commit_count": 18,
    "breakdown": {
        "2021-04-27": 7.4667,
        "2021-04-26": 6.0,
        "2021-04-25": 7.0,
        "2021-04-24": 1.0
    }
  },
  {
    "email": null,
    "author_name": "Total",
    "hours": 34.2837,
    "commit_count": 32
  }
]

Motivation: Useful to evaluate hours for people who get paid in currencies that have daily price fluctuations, it would allow to make more accurate payment according to hourly rate with taking into account daily exchange rates.

opened by marekyggdrasil 2