{"id":13478660,"url":"https://github.com/m1guelpf/auto-commit","last_synced_at":"2025-05-16T07:04:15.562Z","repository":{"id":62336711,"uuid":"559618065","full_name":"m1guelpf/auto-commit","owner":"m1guelpf","description":"A CLI tool that automatically writes commit messages for you.","archived":false,"fork":false,"pushed_at":"2024-03-15T00:41:30.000Z","size":19,"stargazers_count":1211,"open_issues_count":11,"forks_count":56,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-04-08T16:08:04.318Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","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/m1guelpf.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},"funding":{"github":"m1guelpf"}},"created_at":"2022-10-30T17:09:58.000Z","updated_at":"2025-04-03T07:32:56.000Z","dependencies_parsed_at":"2024-01-14T14:32:12.654Z","dependency_job_id":"220c3a4e-0f34-479a-b97a-4b50a8107ad3","html_url":"https://github.com/m1guelpf/auto-commit","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1guelpf%2Fauto-commit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1guelpf%2Fauto-commit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1guelpf%2Fauto-commit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m1guelpf%2Fauto-commit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m1guelpf","download_url":"https://codeload.github.com/m1guelpf/auto-commit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485053,"owners_count":22078767,"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","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":[],"created_at":"2024-07-31T16:02:00.104Z","updated_at":"2025-05-16T07:04:15.534Z","avatar_url":"https://github.com/m1guelpf.png","language":"Rust","funding_links":["https://github.com/sponsors/m1guelpf"],"categories":["Rust"],"sub_categories":[],"readme":"![banner](https://user-images.githubusercontent.com/23558090/198913411-730bd7ff-3d9b-4a5e-831c-55691f97e11a.jpg)\n\n# Automagically-generated commit messages\n\nA CLI tool that generates commit messages from your staged changes, built in Rust and using [OpenAI's GPT-3.5](https://platform.openai.com/overview).\n\n## Installation\n\nYou can install `auto-commit` by running the following command in your terminal.\n\n```\ncurl -fsSL https://raw.githubusercontent.com/m1guelpf/auto-commit/main/install.sh | sh -\n```\n\nOr, if you're an arch user, you can download it from the [AUR](https://aur.archlinux.org/) using\n\n```sh\nyay -S auto-commit\n```\n\nYou may need to close and reopen your terminal after installation. Alternatively, you can download the binary corresponding to your OS from the [latest release](https://github.com/m1guelpf/auto-commit/releases/latest).\n\n## Usage\n\n`auto-commit` uses GPT-3.5. To use it, grab an API key from [your dashboard](https://beta.openai.com/), and save it to `OPENAI_API_KEY` as follows (you can also save it in your bash/zsh profile for persistance between sessions).\n\n```bash\nexport OPENAI_API_KEY='sk-XXXXXXXX'\n```\n\nOnce you have configured your environment, stage some changes by running, for example, `git add .`, and then run `auto-commit`.\n\nOf course, `auto-commit` also includes some options, for editing the message before commiting, or just printing the message to the terminal.\n\n```sh\n$ auto-commit --help\nAutomagically generate commit messages.\n\nUsage: auto-commit [OPTIONS]\n\nOptions:\n  -v, --verbose...  More output per occurrence\n  -q, --quiet...    Less output per occurrence\n      --dry-run     Output the generated message, but don't create a commit.\n  -r, --review      Edit the generated commit message before committing.\n  -h, --help        Print help information\n  -V, --version     Print version information\n```\n\n## Develop\n\nMake sure you have the latest version of rust installed (use [rustup](https://rustup.rs/)). Then, you can build the project by running `cargo build`, and run it with `cargo run`.\n\n## License\n\nThis project is open-sourced under the MIT license. See [the License file](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm1guelpf%2Fauto-commit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm1guelpf%2Fauto-commit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm1guelpf%2Fauto-commit/lists"}