{"id":15199795,"url":"https://github.com/darkyzhou/mcm","last_synced_at":"2025-09-22T04:33:32.876Z","repository":{"id":257621019,"uuid":"853362267","full_name":"darkyzhou/mcm","owner":"darkyzhou","description":"Generate well-formed commit messages based on your staged changes","archived":false,"fork":false,"pushed_at":"2024-09-17T15:58:43.000Z","size":317,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T15:12:43.704Z","etag":null,"topics":["commit","commit-message","conventional-commits","git","llm","zig"],"latest_commit_sha":null,"homepage":"","language":"Zig","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/darkyzhou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-06T14:01:35.000Z","updated_at":"2025-01-13T12:08:13.000Z","dependencies_parsed_at":"2024-09-18T03:33:26.205Z","dependency_job_id":null,"html_url":"https://github.com/darkyzhou/mcm","commit_stats":null,"previous_names":["darkyzhou/mcm"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/darkyzhou/mcm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkyzhou%2Fmcm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkyzhou%2Fmcm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkyzhou%2Fmcm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkyzhou%2Fmcm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darkyzhou","download_url":"https://codeload.github.com/darkyzhou/mcm/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkyzhou%2Fmcm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276347148,"owners_count":25626597,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-22T02:00:08.972Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commit","commit-message","conventional-commits","git","llm","zig"],"created_at":"2024-09-28T02:02:02.467Z","updated_at":"2025-09-22T04:33:32.597Z","avatar_url":"https://github.com/darkyzhou.png","language":"Zig","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MCM - Make Commit Message\n\nA command-line tool that generates well-formed commit messages based on your staged changes and then commits with them.\n\nTo use MCM, you need `git` installed and access to an LLM service.\n\n![Demo](demo.gif)\n\n## Key Features\n\n- 🤖 AI-powered commit message generation based on staged changes\n- 📏 Adherence to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for consistency\n- 🧠 Context-aware messages that capture the essence of your changes\n- 💡 Custom hints to customize AI-generated messages\n- 📝 Built-in editor integration for easy review and modification\n\n## Installation\n\n1. Create a configuration file at `$HOME/.config/mcm/config.toml` with your API key:\n\n```toml\n# Specify your OpenAI API key here. For more configuration options, see the \"Configuration\" section below.\napi_key = \"your_api_key\"\n```\n\n2. Download the appropriate binary for your system from [releases](https://github.com/darkyzhou/mcm/releases).\n\n## Usage\n\nRun MCM in your git repository after staging your changes by `git add`:\n\n```bash\n# Generate a commit message and edit it in the editor:\n$ mcm\n\n# You could also provide a hint for the AI to generate a more specific commit message:\n$ mcm --hint \"make it shorter\"\n$ mcm --hint \"mention also the dependency updates\"\n$ mcm --hint \"the scope should be dns/providers\"\n```\n\n## Limitations\n\n- Only OpenAI and OpenAI-compatible endpoints are supported.\n- Only models and endpoints that supports [Structured Output](https://platform.openai.com/docs/guides/structured-outputs) are supported. For OpenAI endpoint, only the latest `gpt-4o` and `gpt-4o-mini` are supported.\n\n## Roadmap\n\n- [ ] Support more LLM providers like Anthropic, Cloudflare, etc.\n- [ ] Support more languages besides English.\n- [ ] Improve default system prompt for LLM.\n- [ ] Publish the package to various package managers like Homebrew, Nixpkgs, etc.\n\n## Configuration\n\nMCM uses a TOML configuration file located at `$HOME/.config/mcm/config.toml`. Here are the available configuration options:\n\n```toml\n# Required: Your API key for the LLM service\napi_key = \"your_api_key_here\"\n\n# Optional: Base URL for the API (default: \"https://api.openai.com/v1\")\nbase_url = \"https://api.openai.com/v1\"\n\n# Optional: AI model to use (default: \"gpt-4o-mini\")\nmodel = \"gpt-4o-mini\"\n\n# Optional: Custom system prompt for the AI (default: see `src/config.zig#default_system_prompt`)\n# Currently we force the LLM's output to follow the structure defined in `src/request.zig#llm_json_schema`, maybe we could make it also configurable in the future.\nsystem_prompt = \"\"\"\nThe prompt\n\"\"\"\n\n# Optional: Path to your preferred text editor\n# If not specified, MCM checks environment variables `VISUAL` and `EDITOR`.\npath_to_editor = \"/usr/bin/vi\"\n\n# Optional: List of file patterns to ignore when generating commit messages (default: see `src/config.zig#AppConfig`)\n# Refer to git-diff documentation for name format\nignored_files = [\n  \"*.lock*\",\n  \"*-lock.*\",\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkyzhou%2Fmcm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarkyzhou%2Fmcm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkyzhou%2Fmcm/lists"}