GitSet CLI is an integral component of the GitSet.dev ecosystem, designed to enhance Git workflow automation through AI-driven commit message generation. By leveraging Google's Gemini Pro AI technology, it provides intelligent analysis of staged changes to generate contextually appropriate commit messages, supporting both semantic and personalized formatting styles.
The GitSet CLI enhances repository management through:
- AI-Powered Analysis: Utilizes advanced AI processing to analyze staged changes and generate contextually appropriate commit messages
- Semantic Versioning Support: Implements conventional commit standards for maintaining structured version control
- Style Adaptation: Analyzes existing commit patterns to match personal or team commit message conventions
- Efficient Processing: Provides rapid analysis and suggestion generation while maintaining minimal resource utilization
- Cross-Platform Architecture: Ensures consistent operation across various operating systems and environments
- Node.js Runtime Environment (Version 18.0.0 or higher)
- Git (Installed and configured)
- Active internet connection for AI processing
Install the GitSet CLI globally via npm:
npm install -g @gitset-dev/cli
- Stage your modifications:
git add .
- Generate commit message suggestions:
# Semantic versioning format (default)
gitset suggest
# Custom formatting style
gitset suggest --mode custom
- Implement the generated message:
git commit -m "generated_message"
Implements conventional commit standards to generate structured, semantic commit messages. This mode is optimized for maintaining consistent and professional Git history in enterprise environments.
Example output:
$ gitset suggest
✨ Generated Suggestion:
------------------------
feat: Implement JWT authentication system
- Add token generation and validation mechanisms
- Integrate login and registration endpoints
- Configure route protection middleware
Analyzes existing commit patterns to generate messages that align with established conventions:
- Evaluates recent commit history (default: 20 commits) for pattern recognition
- Adapts to existing formatting conventions and structural patterns
- Maintains sequential naming conventions if detected
- Preserves emoji usage patterns and placement
- Replicates capitalization and punctuation styles
- Balances descriptive content with stylistic consistency
Example of style adaptation:
# Given existing commit pattern:
FEATURE_123: Enhanced login interface 🚀
FEATURE_124: Updated navigation system ✨
FEATURE_125: Resolved routing conflicts 🔧
# Generated suggestion maintains consistency:
FEATURE_126: Implemented user preferences 🎯
Primary command:
gitset suggest
- Initiates commit message generation based on staged changes
--mode <mode>
- Specifies generation mode ('semantic' or 'custom')--commit-count <count>
- Defines number of commits to analyze (default: 20)--version
- Displays CLI version information--help
- Provides command usage information
We welcome contributions to enhance the GitSet CLI. Please follow these steps:
- Fork the repository
- Create a feature branch:
git checkout -b feature/enhancement-description
- Implement modifications:
git commit -m 'feat: Add enhancement description'
- Push changes:
git push origin feature/enhancement-description
- Submit a Pull Request
This project operates under the Mozilla Public License 2.0 - refer to LICENSE.md for detailed terms.
- Technical Support: support@gitset.dev
- Contact Form: https://gitset.dev/contact
- Issue Tracking: https://github.com/gitset-dev/gitset-cli/issues
- Contributors who have helped improve this tool
- Commander.js for CLI framework support
- Google's Gemini Pro for AI capabilities
Part of the GitSet.dev ecosystem - Smart AI Documentation & Version Control for GitHub Repositories.