From 915a4ada60dd2dc171fc4879184ea175643b1304 Mon Sep 17 00:00:00 2001 From: Hiroki Osame Date: Fri, 3 Mar 2023 14:30:09 +0900 Subject: [PATCH] docs: passing down flags --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 572b0424..a834fffa 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,12 @@ git add 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.