Skip to content

Commit eaf3096

Browse files
committed
chore(docs): comment out Z.AI GLM configuration to simplify documentation
1 parent e57df42 commit eaf3096

1 file changed

Lines changed: 9 additions & 70 deletions

File tree

README.md

Lines changed: 9 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -101,61 +101,15 @@ providers:
101101
endpoint_url: "http://localhost:11434/v1"
102102
```
103103
104-
**LM Studio (local):**
105-
```yaml
106-
active_provider: openai
107-
providers:
108-
openai:
109-
api_key: "not-needed"
110-
model: "local-model"
111-
endpoint_url: "http://localhost:1234/v1"
112-
```
113-
114-
**Enterprise Proxy:**
115-
```yaml
116-
active_provider: openai
117-
providers:
118-
openai:
119-
api_key: "$ENTERPRISE_OPENAI_KEY"
120-
model: "gpt-4o"
121-
endpoint_url: "https://ai-proxy.company.com/openai/v1"
122-
```
123-
124-
**Z.AI (GLM models):**
125-
```yaml
126-
active_provider: openai
127-
providers:
128-
openai:
129-
api_key: "$ZAI_API_KEY"
130-
model: "glm-4.6"
131-
endpoint_url: "https://api.z.ai/api/paas/v4/"
132-
```
133-
134-
**Available GLM models:**
135-
- `glm-4.6` - Latest GLM model with strong reasoning capabilities
136-
- `glm-4.5` - High-performance model with thinking mode support
137-
- `glm-4.5-air` - Lightweight version of GLM-4.5
138-
139-
To get started with Z.AI:
140-
1. Register at [Z.AI Open Platform](https://z.ai/model-api)
141-
2. Create an API key in the [API Keys](https://z.ai/manage-apikey/apikey-list) management page
142-
3. Set the `ZAI_API_KEY` environment variable or add it to your config
143-
4. Configure lazycommit as shown above
144-
145-
Notes:
146-
- Copilot: requires a GitHub token with models scope. The tool can also discover IDE Copilot tokens, but models scope is recommended.
147-
- Environment variable references are supported by prefixing with `$` (e.g., `$OPENAI_API_KEY`).
148-
- Custom endpoints must be OpenAI-compatible for proper functionality.
149-
- Endpoint URLs are validated to ensure they use HTTP/HTTPS protocols and have valid hosts.
150-
151-
### Configure via CLI
152-
153-
```bash
154-
lazycommit config set # interactive provider/model/key/endpoint picker
155-
lazycommit config get # show current provider/model/endpoint
156-
```
157-
158-
The interactive setup will now prompt for custom endpoint URLs as well. You can leave this field empty to use the default endpoint for the selected provider.
104+
<!-- **Z.AI (GLM models):** -->
105+
<!-- ```yaml -->
106+
<!-- active_provider: openai -->
107+
<!-- providers: -->
108+
<!-- openai: -->
109+
<!-- api_key: "$ZAI_API_KEY" -->
110+
<!-- model: "glm-4.6" -->
111+
<!-- endpoint_url: "https://api.z.ai/api/paas/v4/" -->
112+
<!-- ``` -->
159113

160114
## Integration with TUI Git clients
161115

@@ -181,21 +135,6 @@ customCommands:
181135
labelFormat: "{{ .raw | green }}"
182136
```
183137

184-
Tips:
185-
- For `lazycommit commit`, you can omit `filter` and just use `valueFormat: "{{ .raw }}"` and `labelFormat: "{{ .raw | green }}"`.
186-
- If you pipe a numbered list tool (e.g., `bunx bunnai`), keep the regex groups `number` and `message` as shown.
187-
188-
## Providers and models
189-
190-
- Copilot (default when a GitHub token is available): uses `gpt-4o` unless overridden. Accepts `openai/gpt-4o` and normalizes it to `gpt-4o`.
191-
- OpenAI: choose from models defined in the interactive picker (e.g., gpt‑4o, gpt‑4.1, o3, o1, etc.).
192-
193-
## How it works
194-
195-
- Reads `git diff --cached`.
196-
- Sends a single prompt to the selected provider to generate 10 lines.
197-
- Prints the lines exactly, suitable for piping/selecting.
198-
199138
## Troubleshooting
200139

201140
- "No staged changes to commit." — run `git add` first.

0 commit comments

Comments
 (0)