what-i-have-done
v0.0.1
Published
A command-line tool that fetches your Git commit history and generates an AI-powered monthly development report
Downloads
5
Maintainers
Readme
What I Have Done
A command-line tool that fetches your Git commit history for the last 30 days, sends it to the OpenAI API, and prints a visually rich, retro-style monthly development report in your terminal.
🚀 Features
- Auto-fetch logs: Retrieves commits by your Git user for the specified period.
- AI-powered analysis: Generates insights on:
- Which feature took how many days
- The most refactored feature
- The biggest problem areas
- Your time allocation breakdown
- Retro terminal UI: Outputs ASCII-art boxes, borders, and emojis for a classic, three-dimensional look.
🛠 Prerequisites
- Node.js 12+ (for npm installation)
- Python 3.7+ (required for the tool to run)
gitinstalled and available in yourPATH- An OpenAI API key (create one at https://platform.openai.com)
⚙️ Installation
Option 1: Install via npm (Recommended)
npm install -g what-i-have-doneOption 2: Install from source
Clone this repository
git clone https://github.com/mksengun/what-I-have-done.git cd what-I-have-doneInstall dependencies
pip3 install requestsMake the script executable (optional)
chmod +x what-I-have-done.py
🔧 Configuration
You can provide your OpenAI API key in two ways:
Environment variable (default):
export OPENAI_API_KEY="your-openai-api-key"Command-line argument (overrides environment variable): Add
--api-key YOUR_OPENAI_KEYwhen running the script.
🚀 Usage
If installed via npm:
# Basic usage (uses environment variable):
what-i-have-done
# With inline API key:
what-i-have-done --api-key YOUR_OPENAI_KEYIf running from source:
# Basic (uses environment variable):
python3 what-I-have-done.py
# With inline API key:
python3 what-I-have-done.py --api-key YOUR_OPENAI_KEYExample Commands
# Generate report using environment variable
what-i-have-done
# Generate report with inline API key
what-i-have-done --api-key sk-ABC123xyz📊 Sample Output
+------------------------------------------------------+
| 🚀 Feature Durations |
+------------------------------------------------------+
| • Unified Game Architecture : 12 days |
+------------------------------------------------------+
| • Lesson Module Integration : 1 day |
+------------------------------------------------------+
+------------------------------------------------------+
| 🔍 Analysis |
+------------------------------------------------------+
| • Most refactored feature: Unified Game Architecture |
| • Top problem area: Game state synchronization |
+------------------------------------------------------+ 🤝 Contributing
Contributions, issues, and feature requests are welcome! Open a pull request or issue on GitHub.
📄 License
Distributed under the MIT License.
Made with ❤️ by Mustafa using ChatGPT
