@juspay/neurolink 1.3.0 → 1.5.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 (24) hide show
  1. package/CHANGELOG.md +62 -0
  2. package/README.md +96 -285
  3. package/dist/cli/commands/config.d.ts +33 -3
  4. package/dist/cli/commands/config.js +36 -1
  5. package/dist/cli/index.js +11 -9
  6. package/dist/core/factory.js +6 -2
  7. package/dist/core/types.d.ts +12 -2
  8. package/dist/core/types.js +11 -0
  9. package/dist/mcp/servers/ai-providers/ai-analysis-tools.d.ts +21 -0
  10. package/dist/mcp/servers/ai-providers/ai-analysis-tools.js +215 -0
  11. package/dist/mcp/servers/ai-providers/ai-core-server.d.ts +1 -1
  12. package/dist/mcp/servers/ai-providers/ai-core-server.js +28 -6
  13. package/dist/mcp/servers/ai-providers/ai-workflow-tools.d.ts +101 -0
  14. package/dist/mcp/servers/ai-providers/ai-workflow-tools.js +430 -0
  15. package/dist/neurolink.d.ts +4 -4
  16. package/dist/neurolink.js +109 -56
  17. package/dist/providers/googleAIStudio.d.ts +30 -0
  18. package/dist/providers/googleAIStudio.js +215 -0
  19. package/dist/providers/googleVertexAI.js +2 -2
  20. package/dist/providers/index.d.ts +2 -0
  21. package/dist/providers/index.js +3 -1
  22. package/dist/providers/openAI.js +2 -2
  23. package/dist/utils/providerUtils.js +5 -2
  24. package/package.json +3 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,67 @@
1
1
  # @juspay/neurolink
2
2
 
3
+ ## 1.5.0
4
+
5
+ ### Major Changes
6
+
7
+ - **🧠 Google AI Studio Integration**: Added Google AI Studio as 5th AI provider with Gemini models
8
+ - **🔧 New Provider**: Complete GoogleAIStudio provider with Gemini 1.5/2.0 Flash/Pro models
9
+ - **🆓 Free Tier Access**: Leverage Google's generous free tier for development and testing
10
+ - **🖥️ CLI Support**: Full `--provider google-ai` integration across all commands
11
+ - **⚡ Auto-Selection**: Included in automatic provider selection algorithm
12
+ - **🔑 Simple Setup**: Single `GOOGLE_AI_API_KEY` environment variable configuration
13
+
14
+ ### Features
15
+
16
+ - **📚 Documentation Architecture Overhaul**: Complete README.md restructuring for better UX
17
+ - **75% Size Reduction**: Transformed from 800+ lines to ~200 lines focused on quick start
18
+ - **Progressive Disclosure**: Clear path from basic → intermediate → advanced documentation
19
+ - **Specialized Documentation**: Created 4 dedicated docs files for different audiences
20
+ - **Cross-References**: Complete navigation system between all documentation files
21
+
22
+ ### New Documentation Structure
23
+
24
+ ```
25
+ docs/
26
+ ├── AI-ANALYSIS-TOOLS.md # AI optimization and analysis tools
27
+ ├── AI-WORKFLOW-TOOLS.md # Development lifecycle tools
28
+ ├── MCP-FOUNDATION.md # Technical MCP architecture
29
+ └── GOOGLE-AI-STUDIO-INTEGRATION-ARCHIVE.md # Integration details
30
+ ```
31
+
32
+ ### Google AI Studio Provider
33
+
34
+ ```typescript
35
+ // New Google AI Studio usage
36
+ import { createBestAIProvider } from '@juspay/neurolink';
37
+
38
+ const provider = createBestAIProvider(); // Auto-includes Google AI Studio
39
+ const result = await provider.generateText("Hello, Gemini!");
40
+ ```
41
+
42
+ ```bash
43
+ # Quick setup with Google AI Studio (free tier)
44
+ export GOOGLE_AI_API_KEY="AIza-your-google-ai-key"
45
+ npx @juspay/neurolink generate-text "Hello, AI!" --provider google-ai
46
+ ```
47
+
48
+ ### Enhanced Visual Content
49
+
50
+ - **Google AI Studio Demos**: Complete visual documentation for new provider
51
+ - **CLI Demonstrations**: Updated CLI videos showing google-ai provider
52
+ - **Professional Quality**: 6 new videos and asciinema recordings
53
+
54
+ ### Technical Implementation
55
+
56
+ - **Provider Integration**: `src/lib/providers/googleAIStudio.ts`
57
+ - **Models Supported**: Gemini 1.5 Pro/Flash, Gemini 2.0 Flash/Pro
58
+ - **Authentication**: Simple API key authentication via Google AI Studio
59
+ - **Testing**: Complete test coverage including provider and CLI tests
60
+
61
+ ### Breaking Changes
62
+
63
+ - None - 100% backward compatibility maintained
64
+
3
65
  ## 1.4.0
4
66
 
5
67
  ### Major Changes
package/README.md CHANGED
@@ -4,67 +4,35 @@
4
4
  [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
5
5
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6
6
 
7
- > Production-ready AI toolkit with multi-provider support, automatic fallback, and full TypeScript integration. **Now with MCP Foundation and professional CLI!**
7
+ > Universal AI toolkit with 5+ provider support, automatic fallback, and both CLI + SDK interfaces. Production-ready with TypeScript support.
8
8
 
9
- **NeuroLink** provides a unified interface for AI providers (OpenAI, Amazon Bedrock, Google Vertex AI) with intelligent fallback, streaming support, and type-safe APIs. Available as both a **programmatic SDK** and a **professional CLI tool**. Extracted from production use at Juspay.
10
-
11
- ## 🎉 **NEW: MCP Foundation (Model Context Protocol)**
12
-
13
- **NeuroLink v1.3.0** introduces a groundbreaking **MCP Foundation** that transforms NeuroLink from an AI SDK into a **Universal AI Development Platform** while maintaining the simple factory method interface.
14
-
15
- ### **🏆 Phase 1 Complete: 27/27 Tests Passing**
16
- - ✅ **Factory-First Architecture**: MCP tools work internally, users see simple factory methods
17
- - ✅ **MCP Compatible**: 99% compatible with existing MCP tools and servers
18
- - ✅ **Enterprise Ready**: Rich context, permissions, tool orchestration, analytics
19
- - ✅ **Production Tested**: <1ms tool execution, comprehensive error handling
20
-
21
- ### **🚀 What This Means for You**
22
- ```typescript
23
- // Same simple interface you love
24
- const result = await provider.generateText("Create a React component");
25
-
26
- // But now powered by enterprise-grade MCP tool orchestration internally:
27
- // - Context tracking across tool chains
28
- // - Permission-based security
29
- // - Tool registry and discovery
30
- // - Pipeline execution with error recovery
31
- // - Rich analytics and monitoring
32
- ```
33
-
34
- ### **🔧 MCP Architecture**
35
- - **🏭 MCP Server Factory**: Standard MCP-compatible server creation
36
- - **🧠 Context Management**: Rich context with 15+ fields + tool chain tracking
37
- - **📋 Tool Registry**: Discovery, registration, execution + statistics
38
- - **🎼 Tool Orchestration**: Single tools + sequential pipelines + error handling
39
- - **🤖 AI Provider Integration**: Core AI tools with schema validation
40
-
41
- **Ready for Phase 2**: MCP tool migration enabling unlimited extensibility while preserving the simple interface developers love.
9
+ **NeuroLink** unifies OpenAI, Bedrock, Vertex AI, Google AI Studio, Anthropic, and Azure OpenAI with intelligent fallback and streaming support. Available as both a **programmatic SDK** and **professional CLI tool**. Extracted from production use at Juspay.
42
10
 
43
11
  ## 🚀 Quick Start
44
12
 
45
- ### 📦 Installation
13
+ ### Install & Run (2 minutes)
46
14
 
47
15
  ```bash
48
- # CLI Usage (No Installation Required)
16
+ # Quick setup with Google AI Studio (free tier available)
17
+ export GOOGLE_AI_API_KEY="AIza-your-google-ai-api-key"
18
+
19
+ # CLI - No installation required
49
20
  npx @juspay/neurolink generate-text "Hello, AI!"
50
21
  npx @juspay/neurolink status
51
22
 
52
- # Global CLI Installation
53
- npm install -g @juspay/neurolink
54
- neurolink generate-text "Write a haiku about programming"
55
-
56
23
  # SDK Installation
57
- npm install @juspay/neurolink ai @ai-sdk/amazon-bedrock @ai-sdk/openai @ai-sdk/google-vertex zod
24
+ npm install @juspay/neurolink
58
25
  ```
59
26
 
60
- ### Programmatic Usage
27
+ ### Basic Usage
28
+
61
29
  ```typescript
62
30
  import { createBestAIProvider } from '@juspay/neurolink';
63
31
 
64
32
  // Auto-selects best available provider
65
33
  const provider = createBestAIProvider();
66
34
  const result = await provider.generateText({
67
- prompt: "Hello, AI!"
35
+ prompt: "Write a haiku about programming"
68
36
  });
69
37
 
70
38
  console.log(result.text);
@@ -72,177 +40,59 @@ console.log(`Used: ${result.provider}`);
72
40
  ```
73
41
 
74
42
  ### Environment Setup
43
+
75
44
  ```bash
76
- # Create .env file (automatically loaded by CLI) ✨ NEW!
77
- # OpenAI
45
+ # Create .env file (automatically loaded by CLI)
78
46
  echo 'OPENAI_API_KEY="sk-your-openai-key"' > .env
79
- echo 'OPENAI_MODEL="gpt-4o"' >> .env
80
-
81
- # Amazon Bedrock
47
+ echo 'GOOGLE_AI_API_KEY="AIza-your-google-ai-key"' >> .env
82
48
  echo 'AWS_ACCESS_KEY_ID="your-aws-access-key"' >> .env
83
- echo 'AWS_SECRET_ACCESS_KEY="your-aws-secret-key"' >> .env
84
- echo 'AWS_REGION="us-east-1"' >> .env
85
- echo 'BEDROCK_MODEL="arn:aws:bedrock:region:account:inference-profile/model"' >> .env
86
-
87
- # Google Vertex AI
88
- echo 'GOOGLE_VERTEX_PROJECT="your-project-id"' >> .env
89
- echo 'GOOGLE_VERTEX_LOCATION="us-central1"' >> .env
90
- echo 'GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account.json"' >> .env
91
-
92
- # Anthropic
93
- echo 'ANTHROPIC_API_KEY="sk-ant-api03-your-key"' >> .env
94
49
 
95
- # Azure OpenAI
96
- echo 'AZURE_OPENAI_API_KEY="your-azure-key"' >> .env
97
- echo 'AZURE_OPENAI_ENDPOINT="https://your-resource.openai.azure.com/"' >> .env
98
- echo 'AZURE_OPENAI_DEPLOYMENT_ID="your-deployment-name"' >> .env
99
-
100
- # Test configuration (automatically loads .env)
50
+ # Test configuration
101
51
  npx @juspay/neurolink status
102
52
  ```
103
53
 
104
- **📖 [Complete Environment Variables Guide](./docs/ENVIRONMENT-VARIABLES.md)** - Detailed setup instructions for all providers
105
-
106
- ## 🎬 Complete Visual Documentation
107
-
108
- **No installation required!** Experience NeuroLink's capabilities through our comprehensive visual ecosystem:
109
-
110
- ### 🌐 Web Demo Screenshots & Videos
111
-
112
- #### **📸 Interactive Web Interface Screenshots**
113
- | Feature | Screenshot | Description |
114
- |---------|------------|-------------|
115
- | **Main Interface** | ![Main Interface](./neurolink-demo/screenshots/01-overview/01-main-interface-overview-2025-06-04T13-56-43-628Z.png) | Complete web interface showing all features |
116
- | **AI Generation Results** | ![AI Generation](./neurolink-demo/screenshots/02-basic-examples/02-ai-generation-results-2025-06-04T13-57-13-156Z.png) | Real AI content generation in action |
117
- | **Business Use Cases** | ![Business Cases](./neurolink-demo/screenshots/03-business-use-cases/03-business-use-cases-2025-06-04T13-59-07-846Z.png) | Professional business applications |
118
- | **Creative Tools** | ![Creative Tools](./neurolink-demo/screenshots/04-creative-tools/04-creative-tools-2025-06-04T13-59-24-346Z.png) | Creative content generation |
119
- | **Developer Tools** | ![Developer Tools](./neurolink-demo/screenshots/05-developer-tools/05-developer-tools-2025-06-04T13-59-43-322Z.png) | Code generation and API docs |
120
- | **Analytics & Monitoring** | ![Monitoring](./neurolink-demo/screenshots/06-monitoring/06-monitoring-analytics-2025-06-04T14-00-08-919Z.png) | Real-time provider analytics |
121
-
122
- #### **🎥 Complete Demo Videos** *(Real AI generation showing SDK use cases)*
123
- - **[Basic Examples WebM](./neurolink-demo/videos/basic-examples.webm) | [MP4](./neurolink-demo/videos/basic-examples.mp4)** - Core SDK functionality: text generation, streaming, provider selection, status checks
124
- - **[Business Use Cases WebM](./neurolink-demo/videos/business-use-cases.webm) | [MP4](./neurolink-demo/videos/business-use-cases.mp4)** - Professional applications: marketing emails, quarterly data analysis, executive summaries
125
- - **[Creative Tools WebM](./neurolink-demo/videos/creative-tools.webm) | [MP4](./neurolink-demo/videos/creative-tools.mp4)** - Content creation: storytelling, translation, blog post ideas
126
- - **[Developer Tools WebM](./neurolink-demo/videos/developer-tools.webm) | [MP4](./neurolink-demo/videos/developer-tools.mp4)** - Technical applications: React components, API documentation, error debugging
127
- - **[Monitoring & Analytics WebM](./neurolink-demo/videos/monitoring-analytics.webm) | [MP4](./neurolink-demo/videos/monitoring-analytics.mp4)** - SDK features: performance benchmarks, provider fallback, structured data generation
128
-
129
- **Available formats:**
130
- - **WebM** (web-optimized): All videos available as `.webm` for web embedding
131
- - **MP4** (universal): All videos available as `.mp4` for desktop and mobile compatibility
132
-
133
- ### 🖥️ CLI Tool Screenshots & Videos
134
-
135
- #### **📸 Professional CLI Screenshots** *(Latest: June 8, 2025)*
136
- | Command | Screenshot | Description |
137
- |---------|------------|-------------|
138
- | **CLI Help Overview** | ![CLI Help](./docs/visual-content/screenshots/cli-screenshots/01-cli-help-2025-06-10T12-00-00.png) | Complete command reference |
139
- | **Provider Status Check** | ![Provider Status](./docs/visual-content/screenshots/cli-screenshots/02-provider-status-2025-06-10T12-00-00.png) | All provider connectivity verified |
140
- | **Text Generation** | ![Text Generation](./docs/visual-content/screenshots/cli-screenshots/03-text-generation-2025-06-10T12-00-00.png) | Real AI haiku generation with JSON |
141
- | **Auto Provider Selection** | ![Best Provider](./docs/visual-content/screenshots/cli-screenshots/04-best-provider-2025-06-10T12-00-00.png) | Automatic provider selection working |
142
- | **Batch Processing** | ![Batch Results](./docs/visual-content/screenshots/cli-screenshots/05-batch-results-2025-06-10T12-00-00.png) | Multi-prompt processing with results |
143
-
144
- #### **🎥 CLI Demonstration Videos** *(Professional H.264 MP4 format)*
145
- - **[CLI Help & Overview](./docs/visual-content/cli-videos/cli-help.mp4)** (44KB) - Complete command reference and usage examples
146
- - **[Provider Status Check](./docs/visual-content/cli-videos/cli-provider-status.mp4)** (496KB) - Connectivity testing and response time measurement
147
- - **[Text Generation](./docs/visual-content/cli-videos/cli-text-generation.mp4)** (100KB) - Real AI content generation with different providers
148
- - **[MCP Command Help](./docs/visual-content/cli-videos/mcp-help.mp4)** (36KB) - MCP server management commands
149
- - **[MCP Server Listing](./docs/visual-content/cli-videos/mcp-list.mp4)** (16KB) - MCP server discovery and status
150
-
151
- ### 🔧 MCP (Model Context Protocol) Visual Documentation
152
-
153
- #### **📸 MCP CLI Screenshots** *(Generated Jan 10, 2025)*
154
- | Command | Screenshot | Description |
155
- |---------|------------|-------------|
156
- | **MCP Help Overview** | ![MCP Help](./docs/visual-content/screenshots/mcp-cli/01-mcp-help-2025-06-10.png) | Complete MCP command reference |
157
- | **Server Installation** | ![Install Server](./docs/visual-content/screenshots/mcp-cli/02-mcp-install-2025-06-10.png) | Installing external MCP servers |
158
- | **Server Status Check** | ![Server Status](./docs/visual-content/screenshots/mcp-cli/03-mcp-list-status-2025-06-10.png) | MCP server connectivity and status |
159
- | **Server Testing** | ![Test Server](./docs/visual-content/screenshots/mcp-cli/04-mcp-test-server-2025-06-10.png) | Testing MCP server connectivity |
160
- | **Custom Server Setup** | ![Custom Server](./docs/visual-content/screenshots/mcp-cli/05-mcp-custom-server-2025-06-10.png) | Adding custom MCP server configurations |
161
- | **Workflow Integration** | ![Workflow Demo](./docs/visual-content/screenshots/mcp-cli/06-mcp-workflow-demo-2025-06-10.png) | Complete MCP workflow demonstrations |
162
-
163
- #### **🎥 MCP Demo Videos** *(Real MCP server integration)*
164
- - **[Server Management WebM](./neurolink-demo/videos/mcp-demos/mcp-server-management-demo.webm) | [MP4](./neurolink-demo/videos/mcp-demos/mcp-server-management-demo.mp4)** - Installing, configuring, and testing MCP servers (~45s)
165
- - **[Tool Execution WebM](./neurolink-demo/videos/mcp-demos/mcp-tool-execution-demo.webm) | [MP4](./neurolink-demo/videos/mcp-demos/mcp-tool-execution-demo.mp4)** - Executing tools from external MCP servers (~60s)
166
- - **[Workflow Integration WebM](./neurolink-demo/videos/mcp-demos/mcp-workflow-integration-demo.webm) | [MP4](./neurolink-demo/videos/mcp-demos/mcp-workflow-integration-demo.mp4)** - Complete workflow using multiple MCP servers (~90s)
167
-
168
- **MCP Documentation**: All MCP visual content demonstrates real external server integration and tool execution capabilities.
169
-
170
- **Video Quality**: All CLI videos now use professional H.264 encoding with universal compatibility across platforms and documentation systems.
171
-
172
- ### 💻 Live Interactive Demo
173
- - **Working Express.js server** with real API integration
174
- - **All 3 providers functional** (OpenAI, Bedrock, Vertex AI)
175
- - **15+ use cases** demonstrated across business, creative, and developer tools
176
- - **Real-time provider analytics** with performance metrics
177
-
178
- **Access**: `cd neurolink-demo && npm start` - [📁 View complete visual documentation](./neurolink-demo/)
179
-
180
- ## 📚 Documentation
181
-
182
- ### Quick Reference
183
- - **[🖥️ CLI Guide](./docs/CLI-GUIDE.md)** - Complete CLI commands, options, and examples
184
- - **[🏗️ Framework Integration](./docs/FRAMEWORK-INTEGRATION.md)** - SvelteKit, Next.js, Express.js, React hooks
185
- - **[🔧 Environment Variables](./docs/ENVIRONMENT-VARIABLES.md)** - Complete setup guide for all AI providers
186
- - **[⚙️ Provider Configuration](./docs/PROVIDER-CONFIGURATION.md)** - OpenAI, Bedrock, Vertex AI setup guides
187
- - **[📚 API Reference](./docs/API-REFERENCE.md)** - Complete TypeScript API documentation
188
- - **[🎬 Visual Demos](./docs/VISUAL-DEMOS.md)** - Screenshots, videos, and interactive examples
54
+ **📖 [Complete Setup Guide](./docs/PROVIDER-CONFIGURATION.md)** - All providers with detailed instructions
189
55
 
190
- ### Key Features
56
+ ## ✨ Key Features
191
57
 
192
- 🔄 **Multi-Provider Support** - OpenAI, Amazon Bedrock, Google Vertex AI
193
- ⚡ **Automatic Fallback** - Seamless provider switching on failures
194
- 📡 **Streaming & Non-Streaming** - Real-time responses and standard generation
195
- 🎯 **TypeScript First** - Full type safety and IntelliSense support
196
- 🛡️ **Production Ready** - Extracted from proven production systems
197
- 🔧 **Zero Config** - Works out of the box with environment variables
58
+ - 🔄 **5+ AI Providers** - OpenAI, Bedrock, Vertex AI, Google AI Studio, Anthropic, Azure
59
+ - ⚡ **Automatic Fallback** - Never fail when providers are down
60
+ - 🖥️ **CLI + SDK** - Use from command line or integrate programmatically
61
+ - 🛡️ **Production Ready** - TypeScript, error handling, extracted from production
62
+ - 🔧 **MCP Integration** - Model Context Protocol support for extensibility
63
+ - 🤖 **AI Analysis Tools** - Built-in optimization and workflow assistance
198
64
 
199
- ## 🖥️ CLI Tool
65
+ ## 💻 Essential Examples
200
66
 
201
- ### Core Commands
67
+ ### CLI Commands
202
68
 
203
69
  ```bash
204
- # Text Generation
205
- npx @juspay/neurolink generate-text "Explain quantum computing"
206
- npx @juspay/neurolink generate-text "Write a story" --provider openai --temperature 0.9
70
+ # Text generation with provider selection
71
+ npx @juspay/neurolink generate-text "Explain quantum computing" --provider openai
207
72
 
208
- # Real-time Streaming
73
+ # Real-time streaming
209
74
  npx @juspay/neurolink stream "Tell me a story about robots"
210
75
 
211
- # Batch Processing
76
+ # Provider diagnostics
77
+ npx @juspay/neurolink status --verbose
78
+
79
+ # Batch processing
212
80
  echo -e "Write a haiku\nExplain gravity" > prompts.txt
213
81
  npx @juspay/neurolink batch prompts.txt --output results.json
214
-
215
- # Provider Diagnostics
216
- npx @juspay/neurolink status --verbose
217
- npx @juspay/neurolink get-best-provider
218
82
  ```
219
83
 
220
- ### CLI Features
221
-
222
- ✨ **Professional UX** - Animated spinners, colorized output, progress tracking
223
- 🛠️ **Developer-Friendly** - Multiple output formats, provider selection, status monitoring
224
- 🔧 **Automation Ready** - JSON output, exit codes, scriptable for CI/CD pipelines
225
-
226
- **[📖 View complete CLI documentation](./docs/CLI-GUIDE.md)**
227
-
228
- ## 🏗️ Framework Integration
84
+ ### SDK Integration
229
85
 
230
- ### SvelteKit
231
86
  ```typescript
232
- import { createBestAIProvider } from '@juspay/neurolink';
233
-
87
+ // SvelteKit API route
234
88
  export const POST: RequestHandler = async ({ request }) => {
235
89
  const { message } = await request.json();
236
90
  const provider = createBestAIProvider();
237
91
  const result = await provider.streamText({ prompt: message });
238
92
  return new Response(result.toReadableStream());
239
93
  };
240
- ```
241
-
242
- ### Next.js
243
- ```typescript
244
- import { createBestAIProvider } from '@juspay/neurolink';
245
94
 
95
+ // Next.js API route
246
96
  export async function POST(request: NextRequest) {
247
97
  const { prompt } = await request.json();
248
98
  const provider = createBestAIProvider();
@@ -251,115 +101,76 @@ export async function POST(request: NextRequest) {
251
101
  }
252
102
  ```
253
103
 
254
- ### React Hook
255
- ```typescript
256
- import { useState } from 'react';
257
-
258
- export function useAI() {
259
- const [loading, setLoading] = useState(false);
260
-
261
- const generate = async (prompt: string) => {
262
- setLoading(true);
263
- const response = await fetch('/api/ai', {
264
- method: 'POST',
265
- body: JSON.stringify({ prompt })
266
- });
267
- const data = await response.json();
268
- setLoading(false);
269
- return data.text;
270
- };
271
-
272
- return { generate, loading };
273
- }
274
- ```
275
-
276
- **[📖 View complete framework integration guide](./docs/FRAMEWORK-INTEGRATION.md)**
104
+ ## 🎬 See It In Action
277
105
 
278
- ## ⚙️ Provider Configuration
106
+ **No installation required!** Experience NeuroLink through comprehensive visual documentation:
279
107
 
280
- ### OpenAI
108
+ ### 📱 Interactive Web Demo
281
109
  ```bash
282
- export OPENAI_API_KEY="sk-your-openai-key"
110
+ cd neurolink-demo && node server.js
111
+ # Visit http://localhost:9876 for live demo
283
112
  ```
284
113
 
285
- ### Amazon Bedrock (⚠️ Requires Inference Profile ARN)
286
- ```bash
287
- export AWS_ACCESS_KEY_ID="your-access-key"
288
- export AWS_SECRET_ACCESS_KEY="your-secret-key"
289
- export BEDROCK_MODEL="arn:aws:bedrock:us-east-2:<account_id>:inference-profile/us.anthropic.claude-3-7-sonnet-20250219-v1:0"
290
- ```
291
-
292
- ### Google Vertex AI (Multiple Auth Methods)
293
- ```bash
294
- # Method 1: Service Account File
295
- export GOOGLE_APPLICATION_CREDENTIALS="/path/to/service-account.json"
296
- export GOOGLE_VERTEX_PROJECT="your-project-id"
297
-
298
- # Method 2: JSON String
299
- export GOOGLE_SERVICE_ACCOUNT_KEY='{"type":"service_account",...}'
300
- export GOOGLE_VERTEX_PROJECT="your-project-id"
301
-
302
- # Method 3: Individual Variables
303
- export GOOGLE_AUTH_CLIENT_EMAIL="service-account@project.iam.gserviceaccount.com"
304
- export GOOGLE_AUTH_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\n..."
305
- export GOOGLE_VERTEX_PROJECT="your-project-id"
306
- ```
114
+ - **Real AI Integration**: All 5 providers functional with live generation
115
+ - **Complete Use Cases**: Business, creative, and developer scenarios
116
+ - **Performance Metrics**: Live provider analytics and response times
307
117
 
308
- **[📖 View complete provider configuration guide](./docs/PROVIDER-CONFIGURATION.md)**
118
+ ### 🖥️ CLI Demonstrations
119
+ - **[CLI Help & Commands](./docs/visual-content/cli-videos/cli-01-cli-help.mp4)** - Complete command reference
120
+ - **[Provider Status Check](./docs/visual-content/cli-videos/cli-02-provider-status.mp4)** - Connectivity verification
121
+ - **[Text Generation](./docs/visual-content/cli-videos/cli-03-text-generation.mp4)** - Real AI content creation
309
122
 
310
- ## 📚 API Reference
311
-
312
- ### Core Functions
313
- ```typescript
314
- // Auto-select best provider
315
- const provider = createBestAIProvider();
123
+ ### 🌐 Web Interface Videos
124
+ - **[Business Use Cases](./neurolink-demo/videos/business-use-cases.mp4)** - Professional applications
125
+ - **[Developer Tools](./neurolink-demo/videos/developer-tools.mp4)** - Code generation and APIs
126
+ - **[Creative Tools](./neurolink-demo/videos/creative-tools.mp4)** - Content creation
316
127
 
317
- // Specific provider
318
- const openai = AIProviderFactory.createProvider('openai', 'gpt-4o');
128
+ **[📖 Complete Visual Documentation](./docs/VISUAL-DEMOS.md)** - All screenshots and videos
319
129
 
320
- // With fallback
321
- const { primary, fallback } = createAIProviderWithFallback('bedrock', 'openai');
322
- ```
323
-
324
- ### Provider Interface
325
- ```typescript
326
- interface AIProvider {
327
- generateText(options: GenerateTextOptions): Promise<GenerateTextResult>;
328
- streamText(options: StreamTextOptions): Promise<StreamTextResult>;
329
- }
330
-
331
- interface GenerateTextOptions {
332
- prompt: string;
333
- temperature?: number; // 0.0 to 1.0, default: 0.7
334
- maxTokens?: number; // Default: 500
335
- systemPrompt?: string;
336
- }
337
- ```
338
-
339
- ### Supported Models
340
- - **OpenAI**: `gpt-4o` (default), `gpt-4o-mini`, `gpt-4-turbo`
341
- - **Bedrock**: `claude-3-7-sonnet` (default), `claude-3-5-sonnet`, `claude-3-haiku`
342
- - **Vertex AI**: `gemini-2.5-flash` (default), `claude-sonnet-4@20250514`
343
-
344
- **[📖 View complete API reference](./docs/API-REFERENCE.md)**
345
-
346
- ## 🎯 Visual Content Benefits
347
-
348
- - ✅ **No Installation Required** - See everything in action before installing
349
- - ✅ **Real AI Content** - All screenshots and videos show actual AI generation
350
- - ✅ **Professional Quality** - 1920x1080 resolution suitable for documentation
351
- - ✅ **Complete Coverage** - Every major feature visually documented
352
- - ✅ **Production Validation** - Demonstrates real-world usage patterns
353
-
354
- **[📖 View complete visual demonstrations](./docs/VISUAL-DEMOS.md)**
355
-
356
- ## 🚀 Getting Started
130
+ ## 📚 Documentation
357
131
 
358
- 1. **Try CLI immediately**: `npx @juspay/neurolink status`
359
- 2. **View live demo**: `cd neurolink-demo && npm start`
360
- 3. **Set up providers**: See [Provider Configuration Guide](./docs/PROVIDER-CONFIGURATION.md)
361
- 4. **Integrate with your framework**: See [Framework Integration Guide](./docs/FRAMEWORK-INTEGRATION.md)
362
- 5. **Build with the SDK**: See [API Reference](./docs/API-REFERENCE.md)
132
+ ### Getting Started
133
+ - **[🔧 Provider Setup](./docs/PROVIDER-CONFIGURATION.md)** - Complete environment configuration
134
+ - **[🖥️ CLI Guide](./docs/CLI-GUIDE.md)** - All commands and options
135
+ - **[🏗️ SDK Integration](./docs/FRAMEWORK-INTEGRATION.md)** - Next.js, SvelteKit, React
136
+ - **[⚙️ Environment Variables](./docs/ENVIRONMENT-VARIABLES.md)** - Full configuration guide
137
+
138
+ ### Advanced Features
139
+ - **[🔄 MCP Foundation](./docs/MCP-FOUNDATION.md)** - Model Context Protocol architecture
140
+ - **[🧠 AI Analysis Tools](./docs/AI-ANALYSIS-TOOLS.md)** - Usage optimization and benchmarking
141
+ - **[🛠️ AI Workflow Tools](./docs/AI-WORKFLOW-TOOLS.md)** - Development lifecycle assistance
142
+ - **[🎬 Visual Demos](./docs/VISUAL-DEMOS.md)** - Screenshots and videos
143
+
144
+ ### Reference
145
+ - **[📚 API Reference](./docs/API-REFERENCE.md)** - Complete TypeScript API
146
+ - **[🔗 Framework Integration](./docs/FRAMEWORK-INTEGRATION.md)** - SvelteKit, Next.js, Express.js
147
+
148
+ ## 🏗️ Supported Providers & Models
149
+
150
+ | Provider | Models | Auth Method | Free Tier |
151
+ |----------|--------|-------------|-----------|
152
+ | **OpenAI** | GPT-4o, GPT-4o-mini | API Key | ❌ |
153
+ | **Google AI Studio** | Gemini 1.5/2.0 Flash/Pro | API Key | ✅ |
154
+ | **Amazon Bedrock** | Claude 3.5/3.7 Sonnet | AWS Credentials | ❌ |
155
+ | **Google Vertex AI** | Gemini 2.5 Flash | Service Account | ❌ |
156
+ | **Anthropic** | Claude 3.5 Sonnet | API Key | ❌ |
157
+ | **Azure OpenAI** | GPT-4, GPT-3.5 | API Key + Endpoint | ❌ |
158
+
159
+ **✨ Auto-Selection**: NeuroLink automatically chooses the best available provider based on speed, reliability, and configuration.
160
+
161
+ ## 🎯 Production Features
162
+
163
+ ### Enterprise-Grade Reliability
164
+ - **Automatic Failover**: Seamless provider switching on failures
165
+ - **Error Recovery**: Comprehensive error handling and logging
166
+ - **Performance Monitoring**: Built-in analytics and metrics
167
+ - **Type Safety**: Full TypeScript support with IntelliSense
168
+
169
+ ### AI Platform Capabilities
170
+ - **MCP Foundation**: Universal AI development platform with 10+ specialized tools
171
+ - **Analysis Tools**: Usage optimization, performance benchmarking, parameter tuning
172
+ - **Workflow Tools**: Test generation, code refactoring, documentation, debugging
173
+ - **Extensibility**: Connect external tools and services via MCP protocol
363
174
 
364
175
  ## 🤝 Contributing
365
176
 
@@ -382,7 +193,7 @@ MIT © [Juspay Technologies](https://juspay.in)
382
193
 
383
194
  - [Vercel AI SDK](https://github.com/vercel/ai) - Underlying provider implementations
384
195
  - [SvelteKit](https://kit.svelte.dev) - Web framework used in this project
385
- - [Lighthouse](https://github.com/juspay/lighthouse) - Original source project
196
+ - [Model Context Protocol](https://modelcontextprotocol.io) - Tool integration standard
386
197
 
387
198
  ---
388
199
 
package/dist/cli/commands/config.d.ts CHANGED
@@ -7,7 +7,7 @@
7
7
  */
8
8
  import { z } from 'zod';
9
9
  declare const ConfigSchema: z.ZodObject<{
10
- defaultProvider: z.ZodDefault<z.ZodEnum<["auto", "openai", "bedrock", "vertex", "anthropic", "azure", "huggingface"]>>;
10
+ defaultProvider: z.ZodDefault<z.ZodEnum<["auto", "openai", "bedrock", "vertex", "anthropic", "azure", "google-ai", "huggingface"]>>;
11
11
  providers: z.ZodDefault<z.ZodObject<{
12
12
  openai: z.ZodOptional<z.ZodObject<{
13
13
  apiKey: z.ZodOptional<z.ZodString>;
@@ -92,6 +92,16 @@ declare const ConfigSchema: z.ZodObject<{
92
92
  endpoint?: string | undefined;
93
93
  deploymentId?: string | undefined;
94
94
  }>>;
95
+ 'google-ai': z.ZodOptional<z.ZodObject<{
96
+ apiKey: z.ZodOptional<z.ZodString>;
97
+ model: z.ZodDefault<z.ZodString>;
98
+ }, "strip", z.ZodTypeAny, {
99
+ model: string;
100
+ apiKey?: string | undefined;
101
+ }, {
102
+ apiKey?: string | undefined;
103
+ model?: string | undefined;
104
+ }>>;
95
105
  huggingface: z.ZodOptional<z.ZodObject<{
96
106
  apiKey: z.ZodOptional<z.ZodString>;
97
107
  model: z.ZodDefault<z.ZodString>;
@@ -134,6 +144,10 @@ declare const ConfigSchema: z.ZodObject<{
134
144
  endpoint?: string | undefined;
135
145
  deploymentId?: string | undefined;
136
146
  } | undefined;
147
+ 'google-ai'?: {
148
+ model: string;
149
+ apiKey?: string | undefined;
150
+ } | undefined;
137
151
  huggingface?: {
138
152
  model: string;
139
153
  apiKey?: string | undefined;
@@ -170,6 +184,10 @@ declare const ConfigSchema: z.ZodObject<{
170
184
  endpoint?: string | undefined;
171
185
  deploymentId?: string | undefined;
172
186
  } | undefined;
187
+ 'google-ai'?: {
188
+ apiKey?: string | undefined;
189
+ model?: string | undefined;
190
+ } | undefined;
173
191
  huggingface?: {
174
192
  apiKey?: string | undefined;
175
193
  model?: string | undefined;
@@ -199,7 +217,7 @@ declare const ConfigSchema: z.ZodObject<{
199
217
  cacheStrategy?: "file" | "memory" | "redis" | undefined;
200
218
  }>>;
201
219
  }, "strip", z.ZodTypeAny, {
202
- defaultProvider: "auto" | "openai" | "bedrock" | "vertex" | "anthropic" | "azure" | "huggingface";
220
+ defaultProvider: "auto" | "openai" | "bedrock" | "vertex" | "anthropic" | "azure" | "google-ai" | "huggingface";
203
221
  providers: {
204
222
  openai?: {
205
223
  model: string;
@@ -232,6 +250,10 @@ declare const ConfigSchema: z.ZodObject<{
232
250
  endpoint?: string | undefined;
233
251
  deploymentId?: string | undefined;
234
252
  } | undefined;
253
+ 'google-ai'?: {
254
+ model: string;
255
+ apiKey?: string | undefined;
256
+ } | undefined;
235
257
  huggingface?: {
236
258
  model: string;
237
259
  apiKey?: string | undefined;
@@ -247,7 +269,7 @@ declare const ConfigSchema: z.ZodObject<{
247
269
  cacheStrategy: "file" | "memory" | "redis";
248
270
  };
249
271
  }, {
250
- defaultProvider?: "auto" | "openai" | "bedrock" | "vertex" | "anthropic" | "azure" | "huggingface" | undefined;
272
+ defaultProvider?: "auto" | "openai" | "bedrock" | "vertex" | "anthropic" | "azure" | "google-ai" | "huggingface" | undefined;
251
273
  providers?: {
252
274
  openai?: {
253
275
  apiKey?: string | undefined;
@@ -280,6 +302,10 @@ declare const ConfigSchema: z.ZodObject<{
280
302
  endpoint?: string | undefined;
281
303
  deploymentId?: string | undefined;
282
304
  } | undefined;
305
+ 'google-ai'?: {
306
+ apiKey?: string | undefined;
307
+ model?: string | undefined;
308
+ } | undefined;
283
309
  huggingface?: {
284
310
  apiKey?: string | undefined;
285
311
  model?: string | undefined;
@@ -341,6 +367,10 @@ export declare class ConfigManager {
341
367
  * Azure OpenAI provider setup
342
368
  */
343
369
  private setupAzure;
370
+ /**
371
+ * Google AI Studio provider setup
372
+ */
373
+ private setupGoogleAI;
344
374
  /**
345
375
  * Hugging Face provider setup
346
376
  */