Documentation
Commands
Every flag gitcomm accepts, grouped by staging, committing, suggestions, language, debugging, and general options.
Run npx gitcomm --help for the same list on your machine.
Staging
| Flag | Description |
|---|---|
-a, --all | Stage all tracked working-tree changes first (git add -u) before suggesting. |
--stageddonly | Use only what is already staged. Never auto-stage anything. |
Committing
| Flag | Description |
|---|---|
-c, --commit | Skip the final confirmation and run git commit. |
-n, --dry-run | Print the chosen message without committing. |
-p, --print | Print suggestion subjects to stdout and exit. No prompts. |
--push | Run git push after a successful commit. |
--no-verify | Pass --no-verify to git commit, skipping git hooks. |
Suggestions
| Flag | Description |
|---|---|
-y, --yes | Skip all prompts and take the first suggestion. |
--count <n> | How many suggestions to request. 1 to 5, default 3. |
-t, --type <type> | Force a commit type. One of feat, fix, refactor, docs, test, chore, ci, style, perf, build. |
-s, --scope <scope> | Force a scope, such as auth, api, or ui. |
--body | Prompt for an optional commit body after you pick a subject. |
--force-conventional | Force Conventional Commits style even when your history does not use it. |
--offline | Skip the service and use rule-based suggestions. |
Language
| Flag | Description |
|---|---|
--language <lang> | Force suggestion language. auto (default), en, or id. |
Debugging
| Flag | Description |
|---|---|
-e, --echo | Print the prompt gitcomm would send, then exit. Nothing is transmitted. |
--show-prompt | Alias for --echo. |
--full | With --echo, include the full untruncated diff. |
--verbose | Print diagnostics: which provider ran and how long it took. |
--api-url <url> | Override the configured service URL for this run. |
General
| Flag | Description |
|---|---|
-v, --version | Print the version number. |
-h, --help | Show help. |
Recipes
# Quick commit: stage, take the first suggestion, commit, push
npx gitcomm -a -y -c --push
# See what would be sent, without sending it
npx gitcomm --echo
# No network, rule-based suggestions
npx gitcomm --offline
# Force a type and scope
npx gitcomm -t feat -s auth
# Five suggestions instead of three
npx gitcomm --count 5
# Subjects only, for a script
npx gitcomm --print