ClogX

A pretty log of your montly commits output to a docx file. Handy for reporting your monthly progress to your manager or team.

Install

npm install clogx

Usage

Requirred Arguments

1. --month - The month you want to generate the log for. This can either be the full month name, or the first 3 letters of the month name.
2. --author - The author of the commits you want to generate the log for. Use either the name listed in the commit, or the email address.

Optional Arguments

1. --pdf - If you want to generate a pdf file instead of a docx file. This requires that you have libreoffice installed on your system.
2. --fetch - Makes sure to fetch all the commits from the remote repository before generating the log. This is useful if you have not pulled the latest commits from the remote repository.
3. --waka - Includes editing time for the month for each repo from wakatime. This requires that you have a wakatime account with a wakatime api key. If you are using wakatime in your editor the api key will already be stored in ~/.wakatime.cfg. If not, you will be prompted for the key and it will be stored in ~/.wakatime.cfg to be available to your editor. If you aren't using wakatime in your editor though, it doesn't make much sense to include these statistics in the generated commit log.

Examples

Running local installation

clogx --month=May --author="John Doe" --pdf --fetch --waka

Running with npx

npx clogx --month=May --author="John Doe" --pdf --fetch --waka