GitScope CLI

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

NPM - https://www.npmjs.com/package/gitscope-cli

---

Features

• 📊 Generate formatted commit summaries
• 🎨 Multiple output formats (HTML, JSON, Markdown)
• 🔍 Smart commit type detection
• 📱 Responsive HTML reports
• 🌙 Dark mode support for HTML reports
• 🎯 Branch-specific analysis

---

Installation

npm install -g gitscope-cli

---

Usage

Basic usage:

gitscope

This will generate a JSON report of your last 30 commits.

Options

• -l, --limit <number> - Number of commits to include (default: 30)
• -o, --output <type> - Output format: json, markdown, html (default: json)
• -b, --branch <name> - Analyze specific branch (default: current branch)
• -h, --help - Displays options available to use with this CLI

Examples

1. Generate HTML report for last 20 commits:

   gitscope -l 20 -o html
   

2. Generate Markdown changelog from main branch:

   gitscope -o markdown -b main
   

3. Export JSON data for last 5 commits:

   gitscope -l 5 -o json
   

---

Sample Reports

View sample reports generated using Gitscope CLI:

• HTML Report
• JSON Report
• Markdown Report

These reports showcase different output formats supported by Gitscope CLI:

• The HTML report includes styled tables and commit type indicators
• The JSON report provides structured data for programmatic use
• The Markdown report offers clean, readable changelogs

---

Configuration

GitScope automatically detects your repository settings and adapts its output accordingly.

Output Directory

Reports are saved in the exports directory within your repository:

• HTML reports: exports/gitscope-report-[timestamp].html
• JSON reports: exports/gitscope-report-[timestamp].json
• Markdown reports: exports/gitscope-report-[timestamp].md

---

Contributing

Contributions are welcome! Please check our Contributing Guidelines for details.

Development Setup

1. Clone the repository:

   git clone https://github.com/NitinNair89/gitscope-cli.git
   cd gitscope-cli
   

2. Install dependencies:

   npm install
   

3. Run in development mode:

   npm run dev
   

Running Tests

npm test

---

License

This project is licensed under the MIT License - see the LICENSE file for details.