lynkr 4.0.0 → 4.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/README.md +276 -2873
  2. package/documentation/README.md +98 -0
  3. package/documentation/api.md +806 -0
  4. package/documentation/claude-code-cli.md +672 -0
  5. package/documentation/contributing.md +571 -0
  6. package/documentation/cursor-integration.md +731 -0
  7. package/documentation/docker.md +867 -0
  8. package/documentation/embeddings.md +760 -0
  9. package/documentation/faq.md +659 -0
  10. package/documentation/features.md +396 -0
  11. package/documentation/installation.md +706 -0
  12. package/documentation/memory-system.md +476 -0
  13. package/documentation/production.md +601 -0
  14. package/documentation/providers.md +735 -0
  15. package/documentation/testing.md +629 -0
  16. package/documentation/token-optimization.md +323 -0
  17. package/documentation/tools.md +697 -0
  18. package/documentation/troubleshooting.md +864 -0
  19. package/package.json +1 -1
  20. package/src/api/openai-router.js +393 -42
  21. package/src/api/router.js +172 -22
  22. package/src/clients/databricks.js +82 -7
  23. package/src/clients/openai-format.js +48 -12
  24. package/src/clients/openrouter-utils.js +15 -5
  25. package/src/clients/responses-format.js +214 -0
  26. package/src/clients/standard-tools.js +4 -4
  27. package/src/orchestrator/index.js +32 -0
package/documentation/README.md ADDED
@@ -0,0 +1,98 @@
1
+ # Lynkr Documentation
2
+
3
+ Welcome to the comprehensive documentation for Lynkr, the self-hosted Claude Code proxy with multi-provider support.
4
+
5
+ ---
6
+
7
+ ## Getting Started
8
+
9
+ New to Lynkr? Start here:
10
+
11
+ - **[Installation Guide](installation.md)** - Complete installation instructions for all methods (npm, git clone, homebrew, Docker)
12
+ - **[Provider Configuration](providers.md)** - Detailed setup for all 9+ supported providers (Databricks, Bedrock, OpenRouter, Ollama, llama.cpp, Azure OpenAI, Azure Anthropic, OpenAI, LM Studio)
13
+ - **[Quick Start Examples](installation.md#quick-start-examples)** - Copy-paste configurations to get running fast
14
+
15
+ ---
16
+
17
+ ## IDE Integration
18
+
19
+ Connect Lynkr to your development tools:
20
+
21
+ - **[Claude Code CLI Setup](claude-code-cli.md)** - Configure Claude Code CLI to use Lynkr
22
+ - **[Cursor IDE Integration](cursor-integration.md)** - Full Cursor IDE setup with troubleshooting
23
+ - **[Embeddings Configuration](embeddings.md)** - Enable @Codebase semantic search with 4 provider options (Ollama, llama.cpp, OpenRouter, OpenAI)
24
+
25
+ ---
26
+
27
+ ## Core Features
28
+
29
+ Understand Lynkr's capabilities:
30
+
31
+ - **[Architecture & Features](features.md)** - System architecture, request flow, format conversion, and core capabilities
32
+ - **[Memory System](memory-system.md)** - Titans-inspired long-term memory with surprise-based filtering and decay
33
+ - **[Token Optimization](token-optimization.md)** - Achieve 60-80% cost reduction through smart tool selection, prompt caching, and memory deduplication
34
+ - **[Tools & Execution Modes](tools.md)** - Tool calling, server vs client execution, custom tool integration, MCP support
35
+
36
+ ---
37
+
38
+ ## Deployment & Operations
39
+
40
+ Production deployment guides:
41
+
42
+ - **[Docker Deployment](docker.md)** - docker-compose setup with GPU support, volume management, and multi-service orchestration
43
+ - **[Production Hardening](production.md)** - Circuit breakers, load shedding, Prometheus metrics, health checks, and observability
44
+ - **[API Reference](api.md)** - Complete endpoint documentation, request/response formats, OpenAI compatibility layer
45
+
46
+ ---
47
+
48
+ ## Support & Development
49
+
50
+ Get help and contribute:
51
+
52
+ - **[Troubleshooting Guide](troubleshooting.md)** - Common issues and solutions for all providers
53
+ - **[FAQ](faq.md)** - Frequently asked questions about features, providers, and deployment
54
+ - **[Testing Guide](testing.md)** - Running tests, writing new tests, CI/CD integration
55
+ - **[Contributing Guide](contributing.md)** - How to contribute, code style, pull request process
56
+
57
+ ---
58
+
59
+ ## External Resources
60
+
61
+ - **[DeepWiki Documentation](https://deepwiki.com/vishalveerareddy123/Lynkr)** - AI-powered documentation search and Q&A
62
+ - **[GitHub Repository](https://github.com/vishalveerareddy123/Lynkr)** - Source code and issue tracker
63
+ - **[NPM Package](https://www.npmjs.com/package/lynkr)** - Official npm package
64
+ - **[GitHub Discussions](https://github.com/vishalveerareddy123/Lynkr/discussions)** - Community Q&A and feature discussions
65
+
66
+ ---
67
+
68
+ ## Quick Navigation by Topic
69
+
70
+ ### Setup & Configuration
71
+ - [Installation](installation.md) | [Providers](providers.md) | [Claude Code](claude-code-cli.md) | [Cursor](cursor-integration.md) | [Embeddings](embeddings.md)
72
+
73
+ ### Features & Optimization
74
+ - [Features](features.md) | [Memory System](memory-system.md) | [Token Optimization](token-optimization.md) | [Tools](tools.md)
75
+
76
+ ### Deployment & Production
77
+ - [Docker](docker.md) | [Production](production.md) | [API Reference](api.md)
78
+
79
+ ### Help & Development
80
+ - [Troubleshooting](troubleshooting.md) | [FAQ](faq.md) | [Testing](testing.md) | [Contributing](contributing.md)
81
+
82
+ ---
83
+
84
+ ## Documentation Structure
85
+
86
+ This documentation is organized into focused guides:
87
+
88
+ 1. **Getting Started** - Installation and basic configuration
89
+ 2. **IDE Integration** - Connect to Claude Code and Cursor
90
+ 3. **Core Features** - Deep dives into capabilities
91
+ 4. **Deployment** - Production setup and operations
92
+ 5. **Support** - Troubleshooting and community resources
93
+
94
+ Each guide is self-contained but cross-linked where relevant.
95
+
96
+ ---
97
+
98
+ **Need help?** Check [Troubleshooting](troubleshooting.md) or visit [GitHub Discussions](https://github.com/vishalveerareddy123/Lynkr/discussions).