Skip to content

Gitscope is a lightweight CLI tool that summarizes the key features and changes in a Git repository using structured commit history analysis. It helps developers, teams, and stakeholders quickly understand what’s been built—without reading every commit manually.

License

Notifications You must be signed in to change notification settings

NitinNair89/gitscope-cli

Repository files navigation

Gitscope CLI

GitHub release (latest by date) GitHub Repo stars GitHub commit activity

A lightweight CLI tool to generate beautiful summaries of your Git commit history in HTML, JSON, or Markdown format.

Version: v1.2.3 | Author: @NitinNair89


🚀 Features

  • Summarizes Git commit history from any local repository using a single CLI command
  • Auto-detects Conventional Commit types: feat, fix, chore, refactor, docs, test, release, ci, build
  • Groups commits by category with clean markdown-style formatting
  • Exports commit summaries to HTML, JSON, or Markdown formats
  • Outputs self-contained HTML with inline styling for direct printing or sharing
  • Built for speed and terminal-native usage, ideal for daily dev workflows and reporting needs

📌 Use Cases

  • ✅ Auto-generate changelogs for product releases
  • ✅ Share concise feature updates with clients or team leads
  • ✅ Generate commit-based summaries for dashboards, digests, or audits
  • ✅ Document code contributions clearly across any project
  • ✅ Simplify reporting workflows with zero manual formatting

⚙️ Tech Stack

  • Node.js + TypeScript
  • mri (CLI framework)
  • Git CLI (via child process interface)

📦 Installation

npm i -g gitscope-cli

🧪 Usage

gitscope [options]
Short Long Description Default
-l --limit Number of commits to include -
-o --output Output format: json, markdown, html json
-b --branch Branch to fetch commits from current branch
-h --help Display help message -

Examples

gitscope --limit 5 --output markdown
gitscope -l 20 -o html -b main

Check the full documentation for usage examples and report screenshots.


🧪 Testing

npm test
  • ✅ Uses built-in test runner to validate core CLI functionality.
  • ✅ Ensure all dependencies are installed before running tests.

👨‍💻 Author

Built with ❤️ by Nitin Nair

Front-End Developer • React | Node | TypeScript

About

Gitscope is a lightweight CLI tool that summarizes the key features and changes in a Git repository using structured commit history analysis. It helps developers, teams, and stakeholders quickly understand what’s been built—without reading every commit manually.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •