@sachinthapa572/lazycommit 1.0.1 → 1.2.0

package/README.md

@@ -109,6 +109,47 @@ You can exclude specific files from AI analysis using the `--exclude` flag:
 lazycommit --exclude package-lock.json --exclude dist/
 ```
 
+#### Include commit history for style consistency
+
+You can include recent commit history in the AI prompt to generate messages that match your project's commit style:
+
+```sh
+lazycommit --history
+```
+
+This includes recent commit messages as context, helping the AI match your project's style and conventions. You can customize how many commits to include:
+
+```sh
+lazycommit --history --history-count 5
+```
+
+You can also disable history if it's enabled in your config:
+
+```sh
+lazycommit --no-history
+```
+
+#### One-time guidance override (single run)
+
+You can pass one-time advisory guidance with `--guidance-prompt`:
+
+```sh
+lazycommit --guidance-prompt "Prefer concise verbs and mention auth subsystem"
+```
+
+Behavior:
+
+- Applies only to the current run.
+- Overrides `guidance-prompt` from config for that run.
+- Passing an empty value clears guidance for that run.
+- Does not persist unless you set it through `lazycommit config set`.
+
+Safety behavior:
+
+- Guidance is advisory only (style preference).
+- Output must still follow commit format, be diff-grounded, and remain relevant.
+- Prompt hijacking attempts or unrelated instructions are ignored.
+
 #### Handling large diffs
 
 For large commits with many files, lazycommit automatically stays within API limits and generates relevant commit messages:
@@ -182,6 +223,9 @@ This opens a step-by-step setup flow for:
 - max-length
 - type
 - signup-message
+- history-enabled
+- history-count
+- guidance-prompt
 
 At the end, lazycommit saves your config and prints the updated values.
 
@@ -251,6 +295,12 @@ Required
 
 The Groq API key. You can retrieve it from [Groq Console](https://console.groq.com/keys).
 
+#### CEREBRAS_API_KEY
+
+Required when `provider=cerebras`
+
+The Cerebras API key. You can retrieve it from [Cerebras Platform](https://cloud.cerebras.ai).
+
 #### provider
 
 Default: `groq`
@@ -260,6 +310,7 @@ Provider used to generate commit messages.
 Supported values:
 
 - `groq`
+- `cerebras`
 - `github`
 
 Examples:
@@ -267,6 +318,7 @@ Examples:
 ```sh
 lazycommit config set provider=github
 lazycommit config set provider=groq
+lazycommit config set provider=cerebras
 ```
 
 When switching providers, lazycommit automatically resets `model` to that provider's default if the current model is incompatible.
@@ -309,6 +361,9 @@ Available models by provider:
 - `moonshotai/kimi-k2-instruct`
 - `groq/compound`
 - `groq/compound-mini`
+- `cerebras`:
+- `qwen-3-235b-a22b-instruct-2507` (default)
+- `llama3.1-8b`
 - `github`:
 - `gpt-5-mini` (default)
 - `gpt-5.4-mini`
@@ -318,6 +373,7 @@ Example:
 
 ```sh
 lazycommit config set provider=github model=gpt-5.4-mini
+lazycommit config set CEREBRAS_API_KEY=<your-api-key> provider=cerebras model=qwen-3-235b-a22b-instruct-2507
 ```
 
 #### timeout
@@ -356,6 +412,34 @@ You can clear this option by setting it to an empty string:
 lazycommit config set type=
 ```
 
+#### guidance-prompt
+
+Default: `""` (Empty string)
+
+Optional advisory style guidance for commit message generation.
+
+This value helps steer style preferences (for example: wording nuances, subsystem keywords, or verbosity), but it is treated as **soft guidance only**.
+
+Safety behavior and precedence:
+
+- It does **not** override core commit constraints.
+- Messages must remain grounded in staged diff context.
+- Conflicting, invalid-format, or irrelevant guidance is ignored.
+- Max length: `1000` characters.
+- Whitespace-only values are normalized to empty (feature off).
+
+Example:
+
+```sh
+lazycommit config set guidance-prompt="Prefer concise verbs and include subsystem keywords when relevant"
+```
+
+To clear it:
+
+```sh
+lazycommit config set guidance-prompt=
+```
+
 #### signup-message
 
 Default: `""` (Empty string)
@@ -375,6 +459,30 @@ Example:
 lazycommit config set signup-message="Sachin Thapa <contactsachin572@gmail.com>"
 ```
 
+#### history-enabled
+
+Default: `false`
+
+Whether to include recent commit history in the AI prompt for generating commit messages that match your project's style.
+
+```sh
+lazycommit config set history-enabled=true
+```
+
+Including history helps the AI understand your project's commit message conventions and style, leading to more consistent suggestions.
+
+#### history-count
+
+Default: `3`
+
+The number of recent commit messages to include when `history-enabled` is true. Valid range: `2` to `10`.
+
+```sh
+lazycommit config set history-count=5
+```
+
+This setting only takes effect when history is enabled.
+
 ## How it works
 
 This CLI tool runs `git diff` to grab all your latest code changes, then sends them to the configured provider model and returns AI-generated commit messages.
@@ -449,6 +557,7 @@ If you get a 413 error, your diff is too large for the API. Try these solutions:
 ## Maintainers
 
 - **Sachin Thapa**: [@sachinthapa572](https://github.com/sachinthapa572)
+- **Kshitiz Sharma (imxitiz)**: [@imxitiz](https://github.com/imxitiz)
 
 ## License