Skip to content

Latest commit

 

History

History
142 lines (106 loc) · 4.36 KB

README.md

File metadata and controls

142 lines (106 loc) · 4.36 KB
Raw

logo

travisCI

Git-hours is a command that calculates working time using the git log data.

Download & Run

You can download Git-hours from links down below.

Set Environment

Put the downloaded file into the bin folder, which is set in the $PATH environment variable. Then it will be recognized as a subcommand of git. Because if a command starts with ‘git-‘, git automatically recognizes it as a subcommand of git.

Install using Golang

$ go get -u github.com/lazypic/git-hours

How to use

  1. Open the terminal
  2. Move to your git repository
  3. Type as shown below
$ git hours
From "2019-03-01 00:00:00 +0900" to "2019-03-31 23:59:59 +0900" : 13h20m9s
  • The value of timezone offset is automatically set depending on your region.
  • By default, the start date is set as the first day of last month and the end date is set as the last day of last month.

Detail Options

Help

$ git hours -help


  -author string
    	author name
  -before string
    	before date (default "2020-03-31 23:59:59 +0900")
  -debug
    	debug mode
  -duration string
    	git log duration (default "1h")
  -help
    	print help
  -since string
    	since(after) date (default "2020-03-01 00:00:00 +0900")

Since, Before

You can set the start date and the end date with this options. If you don’t enter any value, the start date and the end date will be set as the first and last date of last month by default.

$ git hours -since 2019-02-01 -before today

If you want to set timezone value, put timezone value at the end of the command as shown below.

$ git hours -since "2019-03-29 13:55:33 +0800"

If you want to customize every value, enter the date, time, and timezone offset value as shown below.

$ git hours -since "2019-03-01 00:00:00 +0900" -before "2019-03-31 23:59:59 +0900"

Author

If you want to know data of particular user, use the -author option as shown below.

$ git hours -author name

Also, You can set more than one user as shown below.

$ git hours -author name1,name2

Duration

Git-hours calculates working time based on duration. If interval between git commits is less than duration value, Git-hours considers working time was continued. With -duration option, you can set duration as you want. By default, duration is set to 1 hour.

If you want to set duration to 30min, type as shown below.

$ git hours -duration 0.5h

Debug

With -debug option, You can see the details. You can see information as following:

  • interval between git commits
  • time
  • author
  • commit message
$ git hours -debug

Output example:

	 2019-03-31 23:28:40 +0900 kim hanwoong edit go fmt
2m26s >
	 2019-03-31 23:31:06 +0900 kim hanwoong 설명을 추가함.
6m34s >
	 2019-03-31 23:37:40 +0900 kim hanwoong edit comment
1m46s >
	 2019-03-31 23:39:26 +0900 hanwoong kim Update README.md
38s >
	 2019-03-31 23:40:04 +0900 hanwoong kim Update README.md
1m12s >
	 2019-03-31 23:41:16 +0900 hanwoong kim Update README.md
From 2019-02-01 to 2019-03-31 : 13h1m48s

Why did I make it?

I want to work regardless of when and where. So, I needed to calculate my working time.

My first try was toggle-style program. I felt that it is demanding tool. because users have to click button every time the work starts or ends.

And the next try was kimmobrunfeldt's git-hours. Mechanism of kimmobrunfeldt's git-hours looked reasonable to me. However, When I tried to install via https://github.com/kimmobrunfeldt/git-hours it didn't work well on my computer because of the node.js dependency.

So, I revised kimmobrunfeldt's git-hours with Go language. Also, while I was revising it, I added some features that help to create an estimate sheet. Git-hours opens to everyone to download and run. Hope it helps those in need.