https://github.com/lionyxml/magit-stats

A git statistics report generator that can be used both as an individual CLI Tool or called from inside Emacs.
https://github.com/lionyxml/magit-stats

cli emacs git npx statistics

Last synced: 5 days ago
JSON representation

A git statistics report generator that can be used both as an individual CLI Tool or called from inside Emacs.

• Host: GitHub
• URL: https://github.com/lionyxml/magit-stats
• Owner: LionyxML
• License: gpl-3.0
• Created: 2023-01-19T02:51:12.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-20T03:52:16.000Z (about 1 month ago)
• Last Synced: 2024-12-19T13:07:33.836Z (5 days ago)
• Topics: cli, emacs, git, npx, statistics
• Language: TypeScript
• Homepage:
• Size: 10.8 MB
• Stars: 37
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# magit-stats

[![img](https://melpa.org/packages/magit-stats-badge.svg)](https://melpa.org/#/magit-stats) ![IMG](https://img.shields.io/badge/npx-magit--stats-red?style=plastic&logo=npm#)

![img](./doc/demo.gif)

## What is this package?

A git statistics report generator that can be use both as an individual CLI

Tool or called from inside Emacs.

Here's a demo of the report:

![img](./doc/demo.png)

## Requirements

You need to have `node@latest` installed in your system and the `npx` tool.

Just check if you have it issuing the command: `npx --version`.

## Basic Usage

Navigate to your git folder and issue:

    npx magit-stats

And that's it! A new `git-stats.html` file is generated with your

repository statistics and will be automatically opened.

## Advanced Usage

You can get all options of this cli tool by issuing `npx magit-stats --help`.

    [magit-stats] - Your git repository statistics

    Usage: npx magit-stats  [options]

    Opções:

          --html      Saves report to HTML file (default: git-stats.html)  [boolean]

          --json      Saves report to JSON file (default: git-stats.json)  [boolean]

          --stdout    Outputs to stdout                                    [boolean]

          --minify    Minifies the JSON output                             [boolean]

          --file      Output file name                                      [string]

          --repo      Repository name to show on report                     [string]

          --no-open   Does not auto-open the generate HTML file            [boolean]

          --no-icons  Does not use icons on HTML                           [boolean]

          --heap      Node memory heap size                 [string] [default: 4096]

      -h, --help      Show help                                            [boolean]

      -v, --version   Show app version                                     [boolean]

    Examples:

      npx magit-stats                          saves report to git-stats.html an ope

                                               ns the file with default app

      npx magit-stats  --html                  same as above

      npx magit-stats  --html --file out.html  saves report to out.html and open it

      npx magit-stats  --html --no-open        saves report to git-stats.html

      npx magit-stats  --json                  saves report to git-stats.json

      npx magit-stats  --json --file out.json  saves report to out.json

      npx magit-stats  --json --stdout         prints JSON report to stdout

## Emacs Usage

NOTE: Requires you to be able to execute \`npx\` (see above) and have it set

to your emacs path.

Install it from [MELPA](https://melpa.org/#/magit-stats) and add to your \`.emacs\` file:

    (require 'magit-stats)

Then open a file that is inside a git repository and call `magit-stats`, like `M-x magit-stats RET`.

Choose an option generate your report!

Demo:

![img](./doc/demo_emacs.png)