copilot-sdk

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #llm #android #machine-learning #rust #docker #awesome #awesome-list #vue #openai

(★ 61)

Copilot SDK for building Production-ready AI Copilots for any product. Connect any LLM, deploy on your infrastructure, own your data. Built for speed and control.

copilot-sdk Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

### Build AI Copilots for Your Product

Production-ready AI Copilots for any product. Connect any LLM, deploy on your infrastructure, own your data. Built for speed and control.

[![npm version](https://img.shields.io/npm/v/@yourgpt/copilot-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@yourgpt/copilot-sdk)
[![npm downloads](https://img.shields.io/npm/dm/@yourgpt/copilot-sdk.svg?style=flat-square)](https://www.npmjs.com/package/@yourgpt/copilot-sdk)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/YourGPT/copilot-sdk/main/LICENSE)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://raw.githubusercontent.com/YourGPT/copilot-sdk/main/CONTRIBUTING.md)
[![GitHub Stars](https://img.shields.io/github/stars/yourgpt/copilot-sdk?style=flat-square)](https://github.com/yourgpt/copilot-sdk/stargazers)

[Documentation](https://copilot-sdk.yourgpt.ai)

<br />

</div>

<br />

## Quick Start

### Install

```bash
npm install @yourgpt/copilot-sdk @yourgpt/llm-sdk openai
```

### Frontend (React)

```tsx
import { CopilotProvider } from "@yourgpt/copilot-sdk/react";
import { CopilotChat } from "@yourgpt/copilot-sdk/ui";
import "@yourgpt/copilot-sdk/ui/styles.css";

function App() {
  return (
    <CopilotProvider runtimeUrl="/api/chat">
      <YourApp />
      <CopilotChat />
    </CopilotProvider>
  );
}
```

### Backend (Next.js)

```ts
// app/api/chat/route.ts
import { streamText } from "@yourgpt/llm-sdk";
import { openai } from "@yourgpt/llm-sdk/openai";

export async function POST(req: Request) {
  const { messages } = await req.json();

const result = await streamText({
    model: openai("gpt-4o"),
    system: "You are a helpful assistant.",
    messages,
  });

return result.toTextStreamResponse();
}
```

<br />

## LLM SDK - Multi-Provider Support

Use any LLM provider with a unified API:

```ts
import { streamText } from "@yourgpt/llm-sdk";
import { openai } from "@yourgpt/llm-sdk/openai";
import { anthropic } from "@yourgpt/llm-sdk/anthropic";
import { google } from "@yourgpt/llm-sdk/google";
import { xai } from "@yourgpt/llm-sdk/xai";

// OpenAI
await streamText({ model: openai("gpt-4o"), messages });

// Anthropic
await streamText({ model: anthropic("claude-sonnet-4-20250514"), messages });

// Google Gemini (uses OpenAI-compatible API)
await streamText({ model: google("gemini-2.0-flash"), messages });

// xAI Grok (uses OpenAI-compatible API)
await streamText({ model: xai("grok-3-fast"), messages });
```

### SDK Requirements

| Provider            | SDK Required        |
| ------------------- | ------------------- |
| OpenAI, Google, xAI | `openai`            |
| Anthropic           | `@anthropic-ai/sdk` |

### Server-Side Tools

Add tools to let the AI call functions on your server:

```ts
import { streamText, tool } from "@yourgpt/llm-sdk";
import { openai } from "@yourgpt/llm-sdk/openai";
import { z } from "zod";

return result.toDataStreamResponse();
```

<br />

## Packages

| Package                      | Description                              |
| ---------------------------- | ---------------------------------------- |
| `@yourgpt/copilot-sdk/react` | React hooks and provider                 |
| `@yourgpt/copilot-sdk/ui`    | Pre-built chat components                |
| `@yourgpt/copilot-sdk/core`  | Core utilities and context capture tools |
| `@yourgpt/llm-sdk`           | Multi-provider LLM SDK with streaming    |

<br />

## Documentation

Visit **[copilot-sdk.yourgpt.ai](https://copilot-sdk.yourgpt.ai)** for full documentation.

- [Getting Started](https://copilot-sdk.yourgpt.ai/docs)
- [Why Copilot SDK](https://copilot-sdk.yourgpt.ai/docs/why-copilot-sdk)
- [LLM SDK](https://copilot-sdk.yourgpt.ai/docs/llm-sdk)
- [Providers](https://copilot-sdk.yourgpt.ai/docs/providers)
- [API Reference](https://copilot-sdk.yourgpt.ai/docs/api-reference)

<br />

## Contributing

We welcome contributions! Whether it's bug reports, feature requests, or code contributions.

- Read our [Contributing Guide](CONTRIBUTING.md) to get started
- Check out [good first issues](../../labels/good%20first%20issue) for beginner-friendly tasks
- Join the discussion in [GitHub Discussions](../../discussions)

**Maintainers:** [@0fficialRohit](https://x.com/0fficialRohit) · [@rege_dev](https://x.com/rege_dev)

<br />

## License

[MIT License](./LICENSE)

copilot-sdk

copilot-sdk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

copilot-sdk

copilot-sdk Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README