@sugarmo/aicommits 1.17.0 → 1.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +30 -0
  2. package/dist/cli.mjs +107 -105
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -80,6 +80,26 @@ If your environment does not provide an interactive TTY, skip prompts explicitly
80
80
  aicommits --confirm # or -y / --yes
81
81
  ```
82
82
 
83
+ #### Print without committing
84
+
85
+ To generate a commit message and print it without creating a Git commit:
86
+
87
+ ```sh
88
+ aicommits --print # or --no-commit
89
+ ```
90
+
91
+ This uses the first generated message and exits before running `git commit`.
92
+
93
+ #### Steer the first AI draft
94
+
95
+ Use `--steer` to give the model one-off context about what the commit is meant to accomplish before it writes the first draft:
96
+
97
+ ```sh
98
+ aicommits --steer "Fix the page failing to load"
99
+ ```
100
+
101
+ The steer text helps the model describe the intent of the change instead of only restating the diff. The diff remains the source of truth if the steer text conflicts with the code.
102
+
83
103
  #### Guide output with Markdown
84
104
 
85
105
  Commit message style is now controlled by a Markdown file instead of individual formatting flags.
@@ -304,6 +324,16 @@ Use `0` to switch back to auto mode:
304
324
  aicommits config set context-window=0
305
325
  ```
306
326
 
327
+ #### include-submodule-commits
328
+
329
+ Default: `false`
330
+
331
+ When a staged or uncommitted change updates a Git submodule pointer, include that submodule's commit log in the diff sent to the model. This gives the model the submodule commit subjects as context instead of only seeing the old and new submodule SHAs.
332
+
333
+ ```sh
334
+ aicommits config set include-submodule-commits=true
335
+ ```
336
+
307
337
  #### message-path
308
338
 
309
339
  Default: `message.md`