Skip to content

quick-start.md

Latest commit

 

History

History
136 lines (99 loc) · 4.41 KB

quick-start.md

File metadata and controls

136 lines (99 loc) · 4.41 KB
description Get NeuroLink running in under 2 minutes. Install the SDK, configure a provider, and stream your first AI response.

import Head from '@docusaurus/Head';

<script type="application/ld+json">{JSON.stringify({ "@context": "https://schema.org", "@type": "HowTo", "name": "Quick Start with NeuroLink AI Streaming SDK", "description": "Stream AI responses in real-time in under 2 minutes", "totalTime": "PT2M", "step": [ { "@type": "HowToStep", "position": 1, "name": "Install NeuroLink", "text": "Run: npm install @juspay/neurolink" }, { "@type": "HowToStep", "position": 2, "name": "Configure provider", "text": "Set your API key as an environment variable" }, { "@type": "HowToStep", "position": 3, "name": "Stream your first response", "text": "Use neurolink.stream() with your prompt and provider" } ] })}</script>

Quick Start

Get NeuroLink running in under 2 minutes with this quick start guide.

🚀 Prerequisites

  • Node.js 18+
  • npm/pnpm/yarn package manager
  • API key for at least one AI provider (we recommend starting with Google AI Studio - it has a free tier)

⚡ 1-Minute Setup

Option 1: CLI Usage (No Installation)

# Set up your API key (Google AI Studio has free tier)
export GOOGLE_AI_API_KEY="AIza-your-google-ai-api-key"

# Generate text instantly
npx @juspay/neurolink generate "Hello, AI"
npx @juspay/neurolink gen "Hello, AI"        # Shortest form

# Check provider status
npx @juspay/neurolink status

Option 2: SDK Installation

# Install for your project
npm install @juspay/neurolink
import { NeuroLink } from "@juspay/neurolink";

const neurolink = new NeuroLink();
const result = await neurolink.generate({
  input: { text: "Write a haiku about programming" },
  provider: "google-ai",
});

console.log(result.content);
console.log(`Used: ${result.provider}`);

Write Once, Run Anywhere

NeuroLink's power is in its provider-agnostic design. Write your code once, and NeuroLink automatically uses the best available provider. If your primary provider fails, it seamlessly falls back to another, ensuring your application remains robust.

import { NeuroLink } from "@juspay/neurolink";

// No provider specified - NeuroLink handles it!
const neurolink = new NeuroLink();

// This code works with OpenAI, Google, Anthropic, etc. without any changes.
const result = await neurolink.generate({
  input: { text: "Explain quantum computing simply." },
});

console.log(result.content);
console.log(`AI Provider Used: ${result.provider}`);

🔑 Get API Keys

Google AI Studio (Free Tier Available)

  1. Visit Google AI Studio
  2. Sign in with your Google account
  3. Click "Get API Key"
  4. Create a new API key
  5. Copy and use: export GOOGLE_AI_API_KEY="AIza-your-key"

Other Providers

✅ Verify Setup

# Check all configured providers
npx @juspay/neurolink status

# Test with built-in tools
npx @juspay/neurolink generate "What time is it?" --debug

# Test without tools (pure text generation)
npx @juspay/neurolink generate "Write a poem" --disable-tools

🎯 Next Steps

  1. Provider Setup - Configure multiple AI providers
  2. CLI Loop Sessions - Try persistent interactive mode with memory
  3. CLI Commands - Learn all available commands
  4. SDK Reference - Integrate into your applications
  5. Examples - See practical implementations

Latest Features:

🆘 Need Help?