{"id":17803380,"url":"https://github.com/sethwebster/ava-commit","last_synced_at":"2025-04-02T04:42:40.705Z","repository":{"id":184940301,"uuid":"672720573","full_name":"sethwebster/ava-commit","owner":"sethwebster","description":"A GPT-based commit message generator","archived":false,"fork":false,"pushed_at":"2023-08-08T18:58:22.000Z","size":154,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-08T10:16:09.936Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sethwebster.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-07-31T02:30:55.000Z","updated_at":"2025-02-11T20:05:18.000Z","dependencies_parsed_at":"2024-10-27T13:07:28.347Z","dependency_job_id":null,"html_url":"https://github.com/sethwebster/ava-commit","commit_stats":null,"previous_names":["sethwebster/ava-commit"],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethwebster%2Fava-commit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethwebster%2Fava-commit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethwebster%2Fava-commit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sethwebster%2Fava-commit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sethwebster","download_url":"https://codeload.github.com/sethwebster/ava-commit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246758284,"owners_count":20828919,"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-10-27T12:46:38.077Z","updated_at":"2025-04-02T04:42:40.686Z","avatar_url":"https://github.com/sethwebster.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @sethwebster/ava-commit\n\n`ava-commit` is a command-line tool that uses ChatGPT to generate git commit messages automatically. It leverages the capabilities of AI to produce informative, human-like messages. This was created as a \nfun pet project while I couldn't sleep and has proven to be really\nuseful in my day-to-day workflow. I hope you find it useful too!\n## Description\nUsing AI to write your commit messages. It's like having an AI pair programmer assisting you with your commits!\n\n## Installation\n\n```bash\nnpm install @sethwebster/ava-commit\n```\n\n## Usage\n\n```bash\nava-commit [options]\n```\n## Commands and Options\n\n| Command         | Options           | Explanation                                                                                          |\n|-----------------|-------------------|------------------------------------------------------------------------------------------------------|\n| `update`        | None              | Checks for updates                                                                                   |\n| `release-notes` | None              | Generates release notes based on what's changed since the most recent tag                            |\n| `configure`     | None              | Configures the tool                                                                                  |\n| `generate`      | `-a, --all`       | Generates a commit message for all commits, not just staged                                          |\n|                 | `-v, --verbose`   | Generates a commit message with verbose output                                                       |\n|                 | `-l, --length`    | Generates a commit message with a targeted max summary length. Default is 80 characters if not set.  |\n|                 | `--all`           | Generates a commit message for all files, bypassing the check for staged files                       |\n|                 | `--length`        | Generates a commit message targeting a specific max summary of characters                            |\n\n#### Examples \n\nTo update the tool:\n\n```bash\nava-commit update\n```\n\nTo generate release notes:\n\n```bash\nava-commit release-notes\n```\n\nTo configure the tool:\n\n```bash\nava-commit configure\n```\n\nTo generate a commit message with all defaults for staged files:\n\n```bash\nava-commit generate\n```\n\nTo generate a commit message for all commits, not just staged:\n\n```bash\nava-commit generate --all\n```\n\nTo generate a verbose commit message:\n\n```bash\nava-commit generate --verbose\n```\n\nTo generate a commit message with a targeted max summary length:\n\n```bash\nava-commit generate --length 150\n```\n\n## Configuration\n\nTo configure ava-commit, you can use the `configure` command. This will guide you through a series of prompts to customize the tool's settings according to your needs. This flow will run automatically the first time you run the `ava-commit`.\n\n## Recommendations\n1. **Alias** -  Personally, I use an alias in my `.zshrc` of `ac` to streamline. It works well with my workflow to set the `generate --all` option on my alias as I generally don't do half-commits. Hopefully you don't miss the \"[Active Time Accounting (ac)](https://man7.org/linux/man-pages/man7/man-pages.7.html)\" tool too much. 🤪\n2. **Workflow** - This is a general workflow suggestion but working in smaller changes leads to better results. While Ava _can_ figure out larger commit sets it gets harder the larger the set is.\n\n## Limitations\n\nPlease be aware that ava-commit, like any AI, may not always generate perfect commit messages. It is intended to be a tool to aid with your development process, but should not be relied upon for mission-critical applications without human review.\n\n## Contributing\n\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsethwebster%2Fava-commit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsethwebster%2Fava-commit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsethwebster%2Fava-commit/lists"}