Skip to content

Commit 06e4137

Browse files
committed
feat(docs): add docs for how to use prompts config
1 parent 6efaff9 commit 06e4137

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,10 @@ lazycommit commit | fzf --prompt='Pick commit> ' | xargs -r -I {} git commit -m
6060

6161
## Configuration
6262

63-
- Config directory (`~/.config/.lazycommit.yaml`
63+
lazycommit uses a two-file configuration system to separate sensitive provider settings from shareable prompt configurations:
64+
65+
### 1. Provider Configuration (`~/.config/.lazycommit.yaml`)
66+
Contains API keys, tokens, and provider-specific settings. **Do not share this file.**
6467

6568
```yaml
6669
active_provider: copilot # default if a GitHub token is found
@@ -80,6 +83,17 @@ providers:
8083
# endpoint_url: "http://localhost:11434/v1"
8184
```
8285

86+
### 2. Prompt Configuration (`~/.config/.lazycommit.prompts.yaml`)
87+
Contains prompt templates and message configurations. **Safe to share in dotfiles and Git.**
88+
89+
This file is automatically created on first run with sensible defaults:
90+
91+
```yaml
92+
system_message: "You are a helpful assistant that generates git commit messages."
93+
commit_message_template: "Based on the following git diff, generate 10 conventional commit messages. Each message should be on a new line, without any numbering or bullet points:\n\n%s"
94+
```
95+
96+
8397
### Custom Endpoints
8498
8599
You can configure custom API endpoints for any provider, which is useful for:

0 commit comments

Comments
 (0)