Skip to content

Commit 8e8919f

Browse files
committed
docs: update multi-language support description to include all languages
1 parent 9ee32a3 commit 8e8919f

1 file changed

Lines changed: 18 additions & 26 deletions

File tree

README.md

Lines changed: 18 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ AI-powered Git commit message generator that analyzes your staged changes and ou
1212
- Generates configurable number of commit message suggestions from your staged diff
1313
- Generates 10 pull request titles based on the diff between the current branch and a target branch
1414
- Providers: GitHub Copilot (default), OpenAI, Anthropic (Claude Code CLI)
15-
- Multi-language support: English and Spanish
15+
- Multi-language support: Any language (English, Arabic, Korean, etc.)
1616
- Interactive config to pick provider/model/language and set keys
1717
- Simple output suitable for piping into TUI menus (one message per line)
1818

@@ -81,7 +81,6 @@ Contains API keys, tokens, and provider-specific settings. **Do not share this f
8181

8282
```yaml
8383
active_provider: copilot # default if a GitHub token is found
84-
language: en # commit message language: "en" (English) or "es" (Spanish)
8584
providers:
8685
copilot:
8786
api_key: "$GITHUB_TOKEN" # Uses GitHub token; token is exchanged internally
@@ -94,35 +93,30 @@ providers:
9493
anthropic:
9594
model: "claude-haiku-4-5" # Uses Claude Code CLI - no API key needed
9695
num_suggestions: 10 # Number of commit suggestions to generate
97-
# Custom provider example (e.g., local Ollama):
98-
# local:
99-
# api_key: "not-needed"
100-
# model: "llama3.1:8b"
101-
# endpoint_url: "http://localhost:11434/v1"
10296
```
10397
104-
#### Anthropic Provider (Claude Code CLI)
105-
106-
The Anthropic provider integrates with your local [Claude Code CLI](https://github.com/anthropics/claude-code) installation:
107-
108-
- **No API key required**: Uses your existing Claude Code authentication
109-
- **Fast and cost-effective**: Leverages Claude Haiku model
110-
- **Configurable**: Set custom number of suggestions per provider
111-
112-
Requirements:
113-
- Claude Code CLI installed and authenticated
114-
- Command `claude` available in PATH
98+
> [!NOTE]
99+
> `.lazycommit.yaml: language` is deprecated and will be removed in a future release. Use `.lazycommit.prompts.yaml` instead.
115100

116101
### 2. Prompt Configuration (`~/.config/.lazycommit.prompts.yaml`)
117102
Contains prompt templates and message configurations. **Safe to share in dotfiles and Git.**
118103

104+
```yaml
105+
language: English # commit message language (e.g., "English", "Arabic", "Korean")
106+
system_message: "You are a helpful assistant that generates git commit messages, and pull request titles."
107+
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"
108+
pr_title_template: "Based on the following git diff, generate 10 pull request title suggestions. Each title should be on a new line, without any numbering or bullet points:\n\n%s"
109+
```
110+
119111
### Per-Repository Configuration
120112

121113
You can override the prompt configuration on a per-repository basis by creating a `.lazycommit.prompts.yaml` file in the root of your git repository. This is useful for projects that require different languages or commit message formats.
122114

115+
If a field is missing in your repository-local configuration, the value from the global configuration will be used.
116+
123117
Example `.lazycommit.prompts.yaml` for a Korean project:
124118
```yaml
125-
language: ko
119+
language: Korean
126120
commit_message_template: "Based on the following git diff, generate 5 conventional commit messages in Korean:\n\n%s"
127121
```
128122

@@ -170,12 +164,14 @@ providers:
170164

171165
### Language Configuration
172166

173-
lazycommit supports generating commit messages in different languages. Set the `language` field in your config:
167+
lazycommit supports generating commit messages in any language. Set the `language` field in your prompt config (`.lazycommit.prompts.yaml`):
174168

175169
```yaml
176-
language: es # Spanish
170+
language: Spanish
171+
# or
172+
language: Arabic
177173
# or
178-
language: en # English (default)
174+
language: English # (default)
179175
```
180176

181177
You can also configure it interactively:
@@ -186,10 +182,6 @@ lazycommit config set # Select language in the interactive menu
186182

187183
The language setting automatically instructs the AI to generate commit messages in the specified language, regardless of the provider used.
188184

189-
**Supported languages:**
190-
- `en` - English (default)
191-
- `es` - Spanish (Español)
192-
193185
## Integration with TUI Git clients
194186

195187
Because `lazycommit commit` prints plain lines, it plugs nicely into menu UIs.

0 commit comments

Comments
 (0)