Skip to content

Commit 1470d27

Browse files
committed
docs(readme): додано документацію про custom API endpoints та multi-repository support
1 parent a91a1d2 commit 1470d27

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,12 @@ You're already investing in Claude Code – whether it's Pro, Max ×5, or Max ×
2525
- **Multilingual support**: Works in English, Ukrainian, and Chinese
2626
- **Flexible backend**: Automatically uses Claude CLI, with API fallback option
2727
- **Smart runtime detection**: Finds Claude CLI from your PATH at runtime without modifying settings (perfect for WSL)
28+
- **Custom BASE_URI support**: Works with custom Claude API endpoints via environment variables
2829
- **In-memory caching**: Remembers the detected CLI path during your session for performance
30+
- **Multi-repository support**: Intelligently detects and works with multiple Git repositories in workspace
31+
- **Comprehensive logging**: Detailed debug logs in Output panel for troubleshooting
32+
- **Privacy mode**: Optional restricted file permissions for temporary prompt files (Linux/macOS)
33+
- **Auto-close notifications**: Configurable auto-dismiss for success messages
2934
- **Progress indicators**: See exactly what's happening during generation
3035
- **Seamless VS Code integration**: Works directly with the built-in Git interface
3136

@@ -43,6 +48,15 @@ This extension works seamlessly in Windows Subsystem for Linux (WSL) environment
4348
- **On Windows**: The extension finds `claude.exe` from the Windows PATH
4449
- **In WSL**: The extension finds `claude` from the Linux PATH
4550
- **No conflicts**: Leaving `claudeCommit.cliPath` empty allows automatic detection in both environments
51+
- **Environment variables**: Login shell support ensures environment variables from `.bashrc`, `.profile`, etc. are properly loaded
52+
53+
### Custom API Endpoint Support
54+
55+
The extension supports custom Claude API endpoints through environment variables:
56+
57+
- **Custom BASE_URI**: Set environment variables for custom API endpoints (e.g., for enterprise deployments)
58+
- **Login shell**: CLI commands are executed with login shell (`-l` flag) to properly load environment variables
59+
- **Full compatibility**: Works with standard Claude API and custom endpoints without configuration changes
4660

4761
## Installation
4862

@@ -216,6 +230,17 @@ Generates: `added user login`
216230
```
217231
Use `{diff}` for git diff content (automatically limited to first 6000 characters) and `{stats}` for change statistics. This allows complete control over the prompt sent to Claude.
218232

233+
## Multi-Repository Support
234+
235+
The extension intelligently handles workspaces with multiple Git repositories:
236+
237+
- **Context-aware**: Automatically detects which repository you're working in based on:
238+
- The Source Control panel you clicked from (highest priority)
239+
- The currently active editor's containing repository
240+
- First repository as fallback
241+
- **No configuration needed**: Works seamlessly with VS Code's built-in multi-repo support
242+
- **Per-repository commits**: Generate commit messages for the correct repository every time
243+
219244
## Troubleshooting
220245

221246
### Claude CLI not found
@@ -307,6 +332,29 @@ This error means Claude CLI was found but didn't return any output. **Check the
307332
- **Network issues**: Check your internet connection
308333
- **Permissions**: Try setting `claudeCommit.privacyMode: false`
309334
- **Corrupted install**: Reinstall Claude CLI (`npm install -g @anthropic-ai/claude-code`)
335+
- **Custom API endpoint**: Ensure environment variables for BASE_URI are properly set in your shell profile
336+
337+
### Using Custom API Endpoints
338+
339+
If you're using a custom Claude API endpoint (e.g., enterprise deployment):
340+
341+
1. **Set environment variables** in your shell profile (`.bashrc`, `.zshrc`, `.profile`):
342+
```bash
343+
export BASE_URI="https://your-custom-endpoint.com"
344+
export ANTHROPIC_API_KEY="your-api-key"
345+
```
346+
347+
2. **Reload your shell** or restart VS Code to apply changes:
348+
```bash
349+
source ~/.bashrc # or ~/.zshrc
350+
```
351+
352+
3. **Verify the setup**:
353+
```bash
354+
claude --version
355+
```
356+
357+
The extension uses a login shell (`-l` flag) to ensure these environment variables are loaded when executing the Claude CLI.
310358

311359
## Privacy & Security
312360

0 commit comments

Comments
 (0)