Loading AgentsKit ecosystem navigation…
AgentsKit Chat
How to

Install and run

Scaffold an AgentsKit Chat app and run it locally.

View canonical Markdown

Install and run

Scaffold

code
pnpm dlx @agentskit/chat-cli@0.4.0 init my-chat --renderer react --yes
cd my-chat
pnpm install
pnpm test
pnpm dlx @agentskit/chat-cli@0.4.0 init my-chat --renderer react --yes

Renderers: react · vue · svelte · solid · angular · react-native · ink — full flags in the CLI.

What the CLI creates

Loading diagram...

Run

code
# scaffolded app
pnpm dev

# monorepo demos
pnpm --filter @agentskit/chat-example-react dev
pnpm --filter @agentskit/chat-example-ink start

Install into an existing app

code
pnpm add @agentskit/chat @agentskit/core
pnpm add @agentskit/react   # or vue / svelte / solid / angular / react-native / ink
code
import { defineChat } from '@agentskit/chat'
import { AgentChat } from '@agentskit/chat/react'
import type { AdapterFactory } from '@agentskit/core'
import '@agentskit/react/theme'

export const createApp = (adapter: AdapterFactory) =>
  defineChat({
    id: 'app',
    chat: { adapter, systemPrompt: 'Be precise. Prefer docs links.' },
  })

export const App = ({ adapter }: { adapter: AdapterFactory }) => (
  <AgentChat definition={createApp(adapter)} placeholder="Ask…" />
)

Adapters (AgentsKit)

Adapters come from AgentsKit providers: currently 25 native adapters spanning 140+ catalog providers and 5k+ models — Chat does not reimplement them.

Live

Hi — this is a live AgentsKit Chat shell. Ask anything about multi-surface chat.

Next