Ezgit is simple tool to streamline your git process. It uses OpenAI to refactor code and auto-generate git messages.
- Install the package via npm:
npm install @robosushie/ezgit- Initialization:
After installing, you need to initialize
ezgitin your project directory:
npx ezgit initThis will check for the presence of a package.json file to ensure you're in a Node.js project directory and then create an ezgit.config.js configuration file.
- Committing Changes: To auto-generate a detailed commit message using OpenAI:
npx ezgit commit- Refactoring Code: To auto-refactor a file using OpenAI:
npx ezgit refactor --path <file path>- Other Git Commands:
You can also use
ezgitto run other git commands:
npx ezgit [your-git-command]Replace [your-git-command] with any git command you wish to execute.
- Auto-Generated Commit Messages: Uses OpenAI's GPT-3.5-turbo model to generate detailed and context-rich commit messages based on your code changes.
- Code Refactoring and Optimizations: Receive recommendations for code improvements and optimizations, ensuring best practices and efficient code. (pending)
dotenv: For environment variable management.openai: To interact with OpenAI's API.yargs: For command line argument parsing.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the ISC License. See LICENSE for more information.
robosushie - GitHub Profile
Project Link: https://github.com/robosushie/ezgit