gitpulse

command module
v1.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 24, 2025 License: MIT Imports: 1 Imported by: 0

README ΒΆ

πŸŒ€ gitpulse

gitpulse is an open-source CLI tool for instantly analyzing Git repository statistics β€” including contributor activity, commit patterns, and directory heat β€” right from your terminal.
It supports both command-line and interactive terminal UI (TUI) modes for a seamless developer experience.


✨ Features

  • πŸ“Š Repository Summary
    Total commits, unique contributors, first & last commits, average commits/day
  • πŸ§‘β€πŸ’» Top Contributors
    Most active committers, ranked by number of commits
  • πŸ”₯ Commit Activity Heatmap
    Visualize commit frequency by weekday
  • πŸ“‚ Most Active Directories
    See which folders change the most
  • πŸ§ͺ TUI Mode
    Interactive, keyboard-navigable terminal interface with tabs

βš™οΈ Installation

Requires Go 1.21+ installed

You can install the latest version directly with Go:

go install github.com/Mertozturkk/gitpulse@latest

Make sure your Go bin directory is in your PATH (usually $HOME/go/bin):

export PATH="$PATH:$(go env GOPATH)/bin"
🧱 Build from Source
Linux & macOS
git clone https://github.com/Mertozturkk/gitpulse.git
cd gitpulse
go build -o gitpulse
Windows
git clone https://github.com/Mertozturkk/gitpulse.git
cd gitpulse
go build -o gitpulse.exe

🚦 Usage

Run from the root of a Git repository:

πŸ”Ή Summary

gitpulse summary

πŸ”Ή Top Contributors

gitpulse authors --top 5

πŸ”Ή Commit Heatmap

gitpulse heatmap --since 30d

πŸ”Ή Active Directories

gitpulse dirs

πŸ”Ή Interactive Terminal UI (TUI)

gitpulse tui

β€’ Navigate tabs with ← β†’ arrows
β€’ Press q to quit

πŸ”Ή Help

gitpulse --help

πŸ› οΈ Contributing

Pull requests and issues are welcome!
Please read CONTRIBUTING.md for details on how to contribute.

  1. Fork the repository
  2. Create a feature branch
  3. Open a pull request
  4. Describe your changes clearly

πŸ“¦ Versioning & Releases

This project uses semantic versioning for long-term maintainability.
You can always install the latest stable version with the @latest tag using Go, or check Releases for versioned binaries in the future.


License

This project is licensed under the MIT License.


Developed by Mertozturkk

Documentation ΒΆ

Overview ΒΆ

Copyright Β© 2025 github.com/Mertozturkk/gitpulse

Directories ΒΆ

Path Synopsis
internal
git

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL