Analyze git hotspots and trigger AI post-processing
Project description
Git Hotspot AI
A lightweight CLI tool for analyzing git hotspots and triggering AI post-processing tasks.
Features
- Git Hotspot Analysis: Identify the most frequently modified files in your repository
- Flexible Filtering: Filter by time range, file patterns, and minimum commit counts
- AI Task Integration: Trigger AI-powered analysis tasks on hotspot files
- Configurable Output: Select top files by percentage or absolute count
- Dry Run Mode: Preview results without executing AI tasks
Installation
From Source
git clone https://github.com/yourusername/git-hotspot-ai.git
cd git-hotspot-ai
pip install -e .
Development Installation
git clone https://github.com/yourusername/git-hotspot-ai.git
cd git-hotspot-ai
pip install -e ".[dev]"
Environment Setup
Required: Before using git-hotspot-ai, you must configure the cursor-agent path:
# Set the environment variable to point to your cursor-agent executable
export CURSOR_AGENT_PATH=/path/to/cursor-agent
# Or if cursor-agent is in your PATH:
export CURSOR_AGENT_PATH=$(which cursor-agent)
# Add to your shell profile for persistence:
echo 'export CURSOR_AGENT_PATH=$(which cursor-agent)' >> ~/.bashrc
# or for zsh:
echo 'export CURSOR_AGENT_PATH=$(which cursor-agent)' >> ~/.zshrc
Usage
Basic Usage
# analyze current directory
git-hotspot-ai
# analyze specific repository
git-hotspot-ai --repo /path/to/repo
# show top 20 files
git-hotspot-ai --top 20
# show top 15% of files
git-hotspot-ai --top 15%
# dry run (preview without AI tasks)
git-hotspot-ai --dry-run
Advanced Options
# analyze files modified in the last 6 months
git-hotspot-ai --since "6 months ago"
# ignore test files and documentation
git-hotspot-ai --ignore "tests/*,docs/*,*.md"
# only consider files with at least 5 commits
git-hotspot-ai --min-commits 5
# run specific AI tasks
git-hotspot-ai --tasks "annotate,structure,performance"
Command Line Options
| Option | Description | Default |
|---|---|---|
--repo |
Path to git repository | Current directory |
--top |
Top files to select (count or percentage) | 10% |
--tasks |
Comma-separated AI tasks | annotate,structure,skills,performance,mvp |
--since |
Git time filter (e.g., "6 months ago") | None |
--dry-run |
Preview without AI tasks | False |
--ignore |
Glob patterns to ignore | Empty |
--min-commits |
Minimum commit count | 1 |
--cursor-agent-path |
Path to cursor-agent executable | CURSOR_AGENT_PATH env var |
AI Tasks
The tool supports the following AI tasks:
- annotate: 为代码添加详细的注释和文档,提高代码可读性
- structure: 分析代码结构,识别重构机会和架构改进建议
- skills: 识别代码所需的技能和专业知识,分析技术栈和最佳实践
- performance: 分析性能特征,识别瓶颈并提出优化建议
- mvp: 生成最小可行产品建议,分析核心功能和简化方案
Each task generates specific prompts tailored to the file's git hotspot metrics (commit frequency, line changes, etc.).
How It Works
- Git Analysis: Uses
git log --numstatto collect file modification statistics - Scoring: Combines commit count and line changes to score files
- Filtering: Applies time range, ignore patterns, and minimum commit filters
- Selection: Selects top files based on percentage or count
- AI Dispatch: Triggers configured AI tasks on selected files
Scoring Algorithm
Files are scored using the formula:
score = commit_count + 0.1 * line_changes
This balances the frequency of changes with the magnitude of changes.
Examples
Find Most Active Files
# top 10 most active files
git-hotspot-ai --top 10
# top 5% of files with at least 3 commits
git-hotspot-ai --top 5% --min-commits 3
Analyze Recent Changes
# files modified in last 3 months
git-hotspot-ai --since "3 months ago"
# recent changes excluding tests
git-hotspot-ai --since "1 month ago" --ignore "test_*,*_test.py"
Development Workflow
# preview what would be analyzed
git-hotspot-ai --dry-run --top 20
# run AI analysis on top files
git-hotspot-ai --top 20 --tasks "annotate,structure"
# use custom cursor-agent path
git-hotspot-ai --cursor-agent-path /usr/local/bin/cursor-agent --tasks "performance"
Cursor Agent Integration
The tool integrates with cursor-agent CLI to perform AI analysis tasks:
# ensure cursor-agent is available
export CURSOR_AGENT_PATH=$(which cursor-agent)
# run analysis with specific tasks
git-hotspot-ai --tasks "annotate,performance" --top 5
# dry run to see what files would be processed
git-hotspot-ai --dry-run --tasks "structure,skills"
Each task generates contextual prompts that include:
- File path and git hotspot metrics
- Task-specific analysis requirements
- Chinese language instructions for better AI understanding
Development
Running Tests
pytest
Code Formatting
black git_hotspot_ai/
isort git_hotspot_ai/
Type Checking
mypy git_hotspot_ai/
Contributing
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests
- Submit a pull request
License
MIT License - see LICENSE file for details.
Changelog
0.1.0
- Initial release
- Basic git hotspot analysis
- CLI interface
- AI task dispatch framework
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file git_hotspot_ai-0.1.0.tar.gz.
File metadata
- Download URL: git_hotspot_ai-0.1.0.tar.gz
- Upload date:
- Size: 10.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f60ce1b32feac7ac1e6f70bf98ab648a4268f9977c60d916cd40a5d0a720f971
|
|
| MD5 |
edac827df6020869a4027df296992f05
|
|
| BLAKE2b-256 |
d70a19aa760e70ddc0d0b8724497cd7a9541b1fb69a859b053bff1ed9d5a7272
|
File details
Details for the file git_hotspot_ai-0.1.0-py3-none-any.whl.
File metadata
- Download URL: git_hotspot_ai-0.1.0-py3-none-any.whl
- Upload date:
- Size: 10.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4eb1b0ec05bed03791b8ce392138154707e900651f05b7d9e3c49206cc689695
|
|
| MD5 |
34e885f2cb8cd9679a0f385edc237bcb
|
|
| BLAKE2b-256 |
d95a9c66ad1ea05fb75089df9b200cc98dfeb5b9c4ff53c1d0553f2478b48082
|