\nA CLI for writing better commits, following the conventional commits specification.\n
\n\n\n\n## โจ Features\n\n- Generate conventional commits through a series of prompts\n- Highly configurable with sane defaults\n- Infers ticket, commit scope, and commit-type from branch for consistent & fast commits\n- Consistent branch / worktree creation with flexible workflow hooks via `better-branch`\n- Interactive git status/add on commit\n- Preview commit messages in color\n- Support for git emojis per commit-type\n- Configure globally or per repository\n- Config validation and error messaging\n- Scriptable and works with agents via CLI flags\n- [Lightweight](https://bundlejs.com/?q=better-commits&treeshake=%5B*%5D) (34kb)\n\nAs a side-effect of formatting messages\n\n- Auto populate PR title / body\n- Automate semantic releases\n- Automate changelogs\n- Automatically link & close related tickets / issues\n\n## ๐ฆ Installation\n\n> Requires Node.js 20 or newer.\n\n```sh\nnpm install -g better-commits\n```\n\n## ๐ Usage\n\nTo run the CLI in your terminal:\n\n```sh\nbetter-commits # Create a new commit\nbetter-branch # Create a new branch / worktree\n```\n\n`better-commits` will prompt a series of questions. These prompts will build a commit message, which you can preview, before confirming the commit. - To better understand these prompts and their intention, read [Conventional Commits Summary](https://www.conventionalcommits.org/en/v1.0.0-beta.4/#summary)\n\nSome of the values in these prompts will be inferred by your branch name and auto populated. You can adjust this in your `.better-commits.jsonc` (or `.better-commits.json`) configuration file.\n\nFor documentation on passing commit values to `better-commits` via the CLI, see [CLI Flags](#cli-flags).\n\n> [!TIP]\n> The `--no-interactive` flag, allows automated workflows or AI agents like OpenCode and Claude Code, to use better-commits to generate consistent commit messages using less tokens.\n>\n> Run `better-commits --help` / `better-branch --help` for more information.\n\n## โ๏ธ Configuration\n\n### Global\n\nYour first time running `better-commits`, a default config will be generated in your `$HOME` directory, named `.better-commits.jsonc` (formerly `.better-commits.json`)\n\n- This config will be used if a repository-specific config cannot be found.\n\n### Repository\n\nTo create a **repository-specific config**, navigate to the root of your project.\n\n- Run `better-commits-init`\n- This will create a default config named `.better-commits.jsonc`\n- Properties such as `confirm_with_editor` and `overrides` will prefer the global config\n\n### ๐ซ Properties\n\n> [!NOTE]