memix
v1.0.3
Published
AI-powered CLI tool to generate clean git commit messages
Readme
memix
AI-powered CLI tool to generate clean git commit messages automatically based on your staged changes.
Installation
Install globally via npm:
npm install -g memixUsage
Navigate to your git repository and stage your changes (git add <files>). Then run:
memixIt will generate a suggested commit message using AI and ask you to confirm before committing.
Setup: API Key Configuration
memix requires a Groq API key to generate commit messages. Please follow these steps:
Sign up and get an API key at Groq Console.
Create a
.envfile in your project folder (or where you runmemix) with this content:
GROQ_KEY=your_api_key_here- Run
memixagain.
Why I Ask You to Provide Your Own API Key
You might be wondering why memix doesn’t "just work" out of the box without needing you to set up an API key.
First, for security reasons, it is obvious not to embed a shared API key, but an actual option is to create a server to handle requests for you. (a "proxy")
That server would accept the commit diff, send it to the AI provider using my hidden API key, and return the result. This way, you'd never see the key, and it would all just work.
That’s actually a solid approach, and I’ve done something similar in other projects. But right now:
- I’m already hosting other apps on Vercel’s free plan.
- I want to keep things lightweight, low-maintenance, and free (for both you and me).
So, for now, I decided not to host an extra server just for memix. It’s something I may revisit in the future if more people start using the tool.
For now, using your own API key is the safest and simplest solution, and I’ve made the setup process as easy as possible.
Notes
Keep your API key private and do not commit your
.envfile to version control.Alternatively, you can set
GROQ_KEYas a global environment variable in your OS.This tool currently requires users to supply their own API key.
For Windows users: use PowerShell or a terminal that supports
.envfiles or environment variables.
Dependencies
License
MIT License © Dayton Baldizón
Feel free to copy-paste this directly!
