Skip to content

Latest commit

 

History

History
89 lines (65 loc) · 3.19 KB

README.md

File metadata and controls

89 lines (65 loc) · 3.19 KB

today

Static Badge GitHub License

Today is a lightweight tool for tracking daily code commits, allowing developers to easily review the number of commits, lines changed and files modified each day.

Usage

Counting everyday commit

By default today shows your commits today. It reads your git commit info and list the commits which is committed by the ${user.name} in global config .

Use today to review what you accomplished today!
Usage:
  today [OPTION...]

  -o, --offset arg     Offset from today (default: 0)
  -d, --directory arg  The working directory to be check (default: .)
  -a, --author arg     Whose commits will be checked
  -h, --help           Print usage
# run
today
# output looks like
Total: Commits 5, Lines Added 118, Lines Removed 9, Files Changed 6.
+=========+======================================+======================+=============+===============+===============+
| Author  | Message                              | Time                 | Lines Added | Lines Removed | Files Changed |
+=========+======================================+======================+=============+===============+===============+
| adamska | doc: polish doc libgit2pp_implement  | 2024-09-11 23:37 CST | 3           | 5             | 1             |
+=========+======================================+======================+=============+===============+===============+
| adamska | feat: use zoned_time                 | 2024-09-11 23:30 CST | 9           | 3             | 4             |
+=========+======================================+======================+=============+===============+===============+
| adamska | feat: support cmake --install        | 2024-09-11 17:07 CST | 15          | 4             | 3             |
+=========+======================================+======================+=============+===============+===============+
| adamska | feat: add --help option              | 2024-09-11 12:43 CST | 75          | 46            | 3             |
+=========+======================================+======================+=============+===============+===============+
| adamska | deps: add cxxopts                    | 2024-09-11 11:42 CST | 16          | 9             | 6             |
+=========+======================================+======================+=============+===============+===============+

Use offset options to check your commit yesterday or before yesterday.

today --offset=-1 # generally only negative number works, you can't predict the future

Setup

Build from source

today depends on libgit2, so make sure you've already installed ligbit2 >= 1.0. On ubuntu, run:

sudo apt-get update
sudo apt-get install libgit2-dev

Ensure that you meet:

  • CMake Version > 3.22
  • C++ Compiler with C++17 support

Run first:

git submodule init
git submodule update

In project source directory run command:

cmake -S . -B build
cmake --build build --config Release

Then you get binary today in build/src/.

Install

cmake --install build --component binary # usually requires sudo