Skip to content

Commit 9628222

Browse files
vishal veerareddyclaude
andcommitted
docs: update index.md with MLX, ClawdBot, and remote support
- Update provider count to 10+ (added MLX OpenAI Server) - Add supported clients table (Claude Code, Cursor, Codex, ClawdBot) - Add remote endpoint support note - Update architecture diagram with MLX and remote option - Add quick config examples (Ollama, MLX, Remote, Bedrock) - Reorganize documentation links by category - Add new features (history compression, remote endpoints) - Update keywords for SEO Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 7fa3f28 commit 9628222

1 file changed

Lines changed: 93 additions & 33 deletions

File tree

docs/index.md

Lines changed: 93 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,13 @@
1010

1111
## What is Lynkr?
1212

13-
Lynkr is a proxy server that enables **Claude Code CLI** and **Cursor IDE** to work with any LLM provider - not just Anthropic.
13+
Lynkr is a proxy server that enables **Claude Code CLI**, **Cursor IDE**, **Codex CLI**, **ClawdBot**, and other AI coding tools to work with any LLM provider - not just Anthropic.
1414

1515
**Key Benefits:**
16-
- **9+ Providers** - Databricks, AWS Bedrock, OpenRouter, Ollama, llama.cpp, Azure OpenAI, Azure Anthropic, OpenAI, LM Studio
16+
- **10+ Providers** - Databricks, AWS Bedrock, OpenRouter, Ollama, llama.cpp, Azure OpenAI, Azure Anthropic, OpenAI, LM Studio, MLX OpenAI Server
1717
- **60-80% Cost Savings** - Token optimization through smart tool selection, prompt caching, and memory deduplication
18-
- **100% Local Option** - Run completely offline with Ollama or llama.cpp (free)
18+
- **100% Local Option** - Run completely offline with Ollama, llama.cpp, or MLX (free)
19+
- **Remote or Local** - Connect to providers on any IP/hostname (not limited to localhost)
1920
- **Drop-in Replacement** - No code changes required to Claude Code CLI or Cursor
2021

2122
---
@@ -56,53 +57,76 @@ claude
5657

5758
## Supported Providers
5859

59-
| Provider | Type | Cost |
60-
|----------|------|------|
61-
| Ollama | Local | FREE |
62-
| llama.cpp | Local | FREE |
63-
| LM Studio | Local | FREE |
64-
| AWS Bedrock | Cloud | $$ |
65-
| OpenRouter | Cloud | $ |
66-
| Databricks | Cloud | $$$ |
67-
| Azure OpenAI | Cloud | $$$ |
68-
| OpenAI | Cloud | $$$ |
60+
| Provider | Type | Cost | Platform |
61+
|----------|------|------|----------|
62+
| Ollama | Local | FREE | Cross-platform |
63+
| llama.cpp | Local | FREE | Cross-platform |
64+
| LM Studio | Local | FREE | Cross-platform |
65+
| MLX OpenAI Server | Local | FREE | Apple Silicon |
66+
| AWS Bedrock | Cloud | $$ | 100+ models |
67+
| OpenRouter | Cloud | $ | 100+ models |
68+
| Databricks | Cloud | $$$ | Claude 4.5 |
69+
| Azure OpenAI | Cloud | $$$ | GPT-4o, o1 |
70+
| Azure Anthropic | Cloud | $$$ | Claude |
71+
| OpenAI | Cloud | $$$ | GPT-4o, o1 |
72+
73+
> 🌐 **Remote Support:** All endpoints support remote addresses - run models on GPU servers, share across teams.
74+
75+
---
76+
77+
## Supported Clients
78+
79+
| Client | Setup |
80+
|--------|-------|
81+
| **Claude Code CLI** | `export ANTHROPIC_BASE_URL=http://localhost:8081` |
82+
| **Cursor IDE** | Settings → Models → Base URL: `http://localhost:8081/v1` |
83+
| **Codex CLI** | `export OPENAI_BASE_URL=http://localhost:8081/v1` |
84+
| **ClawdBot** | Copilot Proxy base URL: `http://localhost:8081/v1` |
85+
| **Cline / Continue.dev** | OpenAI-compatible endpoint |
6986

7087
---
7188

7289
## Documentation
7390

7491
Full documentation: [documentation/](https://github.com/vishalveerareddy123/Lynkr/tree/main/documentation)
7592

93+
### Getting Started
7694
- [Installation](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/installation.md)
7795
- [Provider Configuration](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/providers.md)
96+
- [Troubleshooting](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/troubleshooting.md)
97+
98+
### Client Integration
7899
- [Claude Code CLI Setup](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/claude-code-cli.md)
79100
- [Cursor IDE Integration](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/cursor-integration.md)
101+
- [Embeddings (@Codebase)](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/embeddings.md)
102+
103+
### Features
80104
- [Token Optimization](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/token-optimization.md)
81105
- [Memory System](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/memory-system.md)
82-
- [Embeddings](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/embeddings.md)
106+
- [Headroom Compression](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/headroom.md)
83107
- [API Reference](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/api.md)
84-
- [Troubleshooting](https://github.com/vishalveerareddy123/Lynkr/blob/main/documentation/troubleshooting.md)
85108

86109
---
87110

88111
## Architecture
89112

90113
```
91-
Claude Code CLI / Cursor IDE
92-
93-
94-
┌───────────────┐
95-
│ Lynkr Proxy │ Format conversion, caching,
96-
│ :8081 │ token optimization, tools
97-
└───────┬───────┘
98-
99-
┌───────┴───────┐
100-
▼ ▼
101-
Local Cloud
102-
Ollama Databricks
103-
llama.cpp AWS Bedrock
104-
LM Studio OpenRouter
105-
Azure/OpenAI
114+
Claude Code / Cursor / Codex / ClawdBot
115+
116+
117+
┌───────────────┐
118+
│ Lynkr Proxy │ Format conversion, caching,
119+
│ :8081 │ token optimization, tools
120+
└───────┬───────┘
121+
122+
┌───────────┼───────────┐
123+
▼ ▼ ▼
124+
Local Cloud Remote
125+
─────── ───── ──────
126+
Ollama Databricks GPU Server
127+
llama.cpp Bedrock (any IP)
128+
LM Studio OpenRouter
129+
MLX Server Azure/OpenAI
106130
```
107131

108132
---
@@ -111,11 +135,47 @@ Claude Code CLI / Cursor IDE
111135

112136
- **Multi-Provider Support** - Switch providers without code changes
113137
- **Token Optimization** - 60-80% cost reduction
114-
- **Prompt Caching** - LRU cache with TTL
138+
- **Prompt Caching** - SQLite-backed LRU cache with TTL
115139
- **Long-Term Memory** - Titans-inspired memory system
140+
- **History Compression** - Smart context window management
116141
- **Tool Calling** - Full MCP integration
117142
- **Embeddings** - @Codebase semantic search
118-
- **Enterprise Ready** - Circuit breakers, metrics, health checks
143+
- **Remote Endpoints** - Connect to models on any machine
144+
- **Enterprise Ready** - Circuit breakers, load shedding, metrics, health checks
145+
146+
---
147+
148+
## Quick Config Examples
149+
150+
**Local (Ollama)**
151+
```bash
152+
export MODEL_PROVIDER=ollama
153+
export OLLAMA_MODEL=qwen2.5-coder:latest
154+
```
155+
156+
**Local (MLX - Apple Silicon)**
157+
```bash
158+
# Start MLX server first
159+
mlx-openai-server launch --model-path mlx-community/Qwen2.5-Coder-7B-Instruct-4bit --model-type lm
160+
161+
# Configure Lynkr
162+
export MODEL_PROVIDER=openai
163+
export OPENAI_ENDPOINT=http://localhost:8000/v1/chat/completions
164+
export OPENAI_API_KEY=not-needed
165+
```
166+
167+
**Remote (GPU Server)**
168+
```bash
169+
export MODEL_PROVIDER=ollama
170+
export OLLAMA_ENDPOINT=http://192.168.1.100:11434
171+
```
172+
173+
**Cloud (AWS Bedrock)**
174+
```bash
175+
export MODEL_PROVIDER=bedrock
176+
export AWS_BEDROCK_API_KEY=your-key
177+
export AWS_BEDROCK_MODEL_ID=anthropic.claude-3-5-sonnet-20241022-v2:0
178+
```
119179

120180
---
121181

@@ -136,4 +196,4 @@ Apache 2.0
136196

137197
## Keywords
138198

139-
`claude-code` `claude-proxy` `anthropic-api` `databricks-llm` `aws-bedrock` `openrouter` `ollama` `llama-cpp` `azure-openai` `mcp-server` `prompt-caching` `token-optimization` `ai-coding-assistant` `llm-proxy` `self-hosted-ai`
199+
`claude-code` `claude-proxy` `anthropic-api` `databricks-llm` `aws-bedrock` `openrouter` `ollama` `llama-cpp` `mlx` `azure-openai` `mcp-server` `prompt-caching` `token-optimization` `ai-coding-assistant` `llm-proxy` `self-hosted-ai` `cursor-ide` `codex-cli` `clawdbot`

0 commit comments

Comments
 (0)