JSPM

  • Created
  • Published
  • Downloads 534
  • Score
    100M100P100Q88746F
  • License MIT

Build AI copilots with app context awareness

Package Exports

  • @yourgpt/copilot-sdk/core
  • @yourgpt/copilot-sdk/react
  • @yourgpt/copilot-sdk/ui
  • @yourgpt/copilot-sdk/ui/styles.css

Readme

@yourgpt/copilot-sdk

Build AI Copilots for Your Product.

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

Installation

npm install @yourgpt/copilot-sdk @yourgpt/llm-sdk

Quick Start

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>
  );
}

Subpath Exports

Subpath Description
/react React hooks and provider
/ui Pre-built UI components
/core Types, utilities, tool helpers

Styling (Tailwind CSS v4)

Add the SDK source to your Tailwind config:

/* app/globals.css */
@import "tailwindcss";

@source "node_modules/@yourgpt/copilot-sdk/src/**/*.{ts,tsx}";

@custom-variant dark (&:is(.dark *));

For theming, optionally import the default CSS variables:

@import "@yourgpt/copilot-sdk/ui/styles.css";

Documentation

Visit copilot-sdk.yourgpt.ai

License

MIT