docs: passing down flags

2023-03-03 14:30:09 +09:00
parent 29856386a7
commit 915a4ada60
1 changed files with 6 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -56,6 +56,12 @@ git add <files...>
 aicommits
 ```

+`aicommits` passes down unknown flags to `git commit`, so you can pass in [`commit` flags](https://git-scm.com/docs/git-commit) (with some exceptions (e.g. `--all`):
+
+```sh
+aicommits --dry-run
+```
+
 ### Git hook

 You can also integrate _aicommits_ with Git via the [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. This lets you use Git like you normally would, and edit the commit message before committing.