git-streak-chart v1.0.4

Git Streak Chart

git-streak-chart is a CLI tool that generates a visual streak chart based on your Git commit history. It helps you visualize your most productive days and weeks by analyzing commits over the last six weeks.

Features

• Visualize your Git commit activity in a 7x6 grid (representing the last 6 weeks).
• Supports filtering by author name or email.
• Automatically uses your Git-configured email if no author is provided.
• Ideal for personal tracking of Git productivity.

Installation

You can run this tool directly via npx (no installation needed):

npx git-streak-chart

Or, install it globally:

npm install -g git-streak-chart

Usage

Basic Usage

To generate the streak chart for the current Git user (detected from Git config):

npx git-streak-chart

Specify an Author

To generate the streak chart for a specific author by name or email:

npx git-streak-chart "author@example.com"

Example Output

Your Git Commit Streak Chart (Last 6 Weeks) for "author@example.com":

┌───────┬───────┬───────┬───────┬───────┬───────┬───────┐
│  Mon  │  Tue  │  Wed  │  Thu  │  Fri  │  Sat  │  Sun  │
├───────┼───────┼───────┼───────┼───────┼───────┼───────┤
│       │ 🔥 3  │       │ 🔥 1  │ 🔥 2  │       │ 🔥 4  │
├───────┼───────┼───────┼───────┼───────┼───────┼───────┤
│ 🔥 2  │ 🔥 1  │       │       │ 🔥 2  │ 🔥 1  │       │
└───────┴───────┴───────┴───────┴───────┴───────┴───────┘

Error Handling

• No Git User Email Found: If the script cannot find your Git email in the config, it will prompt you to manually provide the author name or email.
• No Commits Found: If no commits are found for the specified author, it will notify you.
• Git Log Access Error: If the tool can't access the Git log (e.g., you are not in a Git repo), an error message will be shown.

Author

aalim aslam