Skip to content

Commit 661b999

Browse files
committed
Update README table of git commit flags support
- Reorder and regroup flags for better readability - Add missing flags like --fixup, --short, --porcelain, etc. - Mark -m flag as "Modified" since it provides context to AI - Update legend to include "Modified" status
1 parent d3a7bac commit 661b999

1 file changed

Lines changed: 28 additions & 17 deletions

File tree

README.md

Lines changed: 28 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -367,39 +367,50 @@ The following table shows all standard `git commit` flags and their support stat
367367
|------|-------------|--------|
368368
| `-a, --all` | Auto-stage all tracked modified files |**Supported** |
369369
| `--interactive` | Interactively add files | ❌ Not supported |
370-
| `--patch` | Interactively add hunks of patch | ❌ Not supported |
371-
| `-s, --signoff` | Add Signed-off-by trailer | ❌ Not supported |
372-
| `-v, --verbose` | Show diff in commit message editor |**Supported** |
373-
| `-u<mode>, --untracked-files[=<mode>]` | Show untracked files | ❌ Not supported |
374-
| `--amend` | Amend the previous commit |**Supported** |
375-
| `--dry-run` | Don't actually commit, just show what would be committed |**Supported** |
376-
| `-c, --reedit-message=<commit>` | Reuse and edit message from specified commit | ❌ Not supported |
377-
| `-C, --reuse-message=<commit>` | Reuse message from specified commit | ❌ Not supported |
370+
| `-p, --patch` | Interactively add hunks of patch | ❌ Not supported |
371+
| `-C <commit>, --reuse-message=<commit>` | Reuse message from specified commit | ❌ Not supported |
372+
| `-c <commit>, --reedit-message=<commit>` | Reuse and edit message from specified commit | ❌ Not supported |
373+
| `--fixup=[(amend\|reword):]<commit>` | Construct commit for autosquash rebase | ❌ Not supported |
378374
| `--squash=<commit>` | Construct commit for squashing | ❌ Not supported |
379-
| `--fixup=<commit>` | Construct commit for autosquash rebase | ❌ Not supported |
380-
| `-F, --file=<file>` | Read commit message from file | ❌ Not supported |
381375
| `--reset-author` | Reset author information | ❌ Not supported |
382-
| `--allow-empty` | Allow empty commits |**Supported** |
383-
| `--allow-empty-message` | Allow commits with empty message | ❌ Not supported |
384-
| `--no-verify, -n` | Skip pre-commit and commit-msg hooks |**Supported** |
385-
| `-e, --edit` | Force edit of commit message | ❌ Not supported |
376+
| `--short` | Show short-format status (dry-run) | ❌ Not supported |
377+
| `--branch` | Show branch info in short-format | ❌ Not supported |
378+
| `--porcelain` | Machine-readable output (dry-run) | ❌ Not supported |
379+
| `--long` | Show long-format status (dry-run) | ❌ Not supported |
380+
| `-z, --null` | Terminate entries with NUL | ❌ Not supported |
381+
| `-F <file>, --file=<file>` | Read commit message from file | ❌ Not supported |
386382
| `--author=<author>` | Override author information |**Supported** |
387383
| `--date=<date>` | Override author date |**Supported** |
384+
| `-m <msg>, --message=<msg>` | Commit message | ⚠️ **Modified** (provides context to AI) |
385+
| `-t <file>, --template=<file>` | Use template file for message | ❌ Not supported |
386+
| `-s, --signoff, --no-signoff` | Add Signed-off-by trailer | ❌ Not supported |
387+
| `--trailer <token>[(=\|:)<value>]` | Add custom trailers to message | ❌ Not supported |
388+
| `-n, --no-verify` | Skip pre-commit and commit-msg hooks |**Supported** |
389+
| `--allow-empty` | Allow empty commits |**Supported** |
390+
| `--allow-empty-message` | Allow commits with empty message | ❌ Not supported |
388391
| `--cleanup=<mode>` | Set commit message cleanup mode | ❌ Not supported |
389-
| `--status` | Include git status in commit editor | ❌ Not supported |
390-
| `--no-status` | Don't include git status in commit editor | ❌ Not supported |
392+
| `-e, --edit` | Force edit of commit message | ❌ Not supported |
393+
| `--no-edit` | Use message without editing | ❌ Not supported |
394+
| `--amend` | Amend the previous commit |**Supported** |
395+
| `--no-post-rewrite` | Bypass post-rewrite hook | ❌ Not supported |
391396
| `-i, --include` | Stage specified files in addition to staged | ❌ Not supported |
392397
| `-o, --only` | Commit only specified files | ❌ Not supported |
393398
| `--pathspec-from-file=<file>` | Read pathspec from file | ❌ Not supported |
394399
| `--pathspec-file-nul` | NUL-separated pathspec file | ❌ Not supported |
395-
| `--trailer <token>[(=\|:)<value>]` | Add trailers to commit message | ❌ Not supported |
400+
| `-u[<mode>], --untracked-files[=<mode>]` | Show untracked files | ❌ Not supported |
401+
| `-v, --verbose` | Show diff in commit message editor |**Supported** |
402+
| `-q, --quiet` | Suppress commit summary message | ❌ Not supported |
403+
| `--dry-run` | Don't actually commit, just show what would be committed |**Supported** |
404+
| `--status` | Include git status in commit editor | ❌ Not supported |
405+
| `--no-status` | Don't include git status in commit editor | ❌ Not supported |
396406
| `-S[<keyid>], --gpg-sign[=<keyid>]` | GPG-sign commit | ❌ Not supported |
397407
| `--no-gpg-sign` | Don't GPG-sign commit | ❌ Not supported |
398408
| `--` | Separate paths from options | ❌ Not supported |
399409
| `<pathspec>...` | Commit only specified paths | ❌ Not supported |
400410

401411
#### Legend
402412
-**Supported** - Fully functional in git-commitai
413+
- ⚠️ **Modified** - Works differently than standard git commit
403414
- ❌ Not supported - Not yet implemented
404415

405416
### Supported Providers

0 commit comments

Comments
 (0)