Skip to content

PaladinKnightMaster/CopilotKit

ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4,625 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
FavIcon

CopilotKit

Docs ยท Examples ยท Copilot Cloud ยท Discord

Build agent-native applications with generative UI, shared state, and human-in-the-loop workflows.

CopilotKit



What is CopilotKit

CopilotKit is a best-in-class SDK for building full-stack agentic applications, Generative UI, and chat applications.

We are the company behind the AG-UI Protocol, adopted by Google, LangChain, AWS, Microsoft, Mastra, PydanticAI, and more!

abb2bbad-c615-49f6-9c05-e8848b19da0b.mp4

Features:

  • Chat UI โ€“ A React-based chat interface that supports message streaming, tool calls, and agent responses.
  • Backend Tool Rendering โ€“ Enables agents to call backend tools that return UI components rendered directly in the client.
  • Generative UI โ€“ Allows agents to generate and update UI components dynamically at runtime based on user intent and agent state.
  • Shared State โ€“ A synchronized state layer that both agents and UI components can read from and write to in real time.
  • Human-in-the-Loop โ€“ Lets agents pause execution to request user input, confirmation, or edits before continuing.
full-headless-chat.mp4

Quick Start

New projects:

npx copilotkit@latest create -f <framework>

Existing projects:

npx copilotkit@latest init
cpk-cli.mp4

What this gives you:

  • CopilotKit installed โ€“ Core packages are fully set up in your app
  • Provider configured โ€“ Context, state, and hooks ready to use
  • Agent <> UI connected โ€“ Agents can stream actions and render UI immediately
  • Deployment-ready โ€“ Your app is ready to deploy

Complete getting started guide โ†’

How it works:

CopilotKit connects your UI, agents, and tools into a single interaction loop.

CopilotKit Diagram โ€” Motion x2 6 sec version

This enables:

  • Agents that ask users for input
  • Tools that render UI
  • Stateful workflows across steps and sessions

โญ๏ธ useAgent Hook

The useAgent hook is a proper superset of useCoAgent and sits directly on AG-UI, giving more control over the agent connection.

// Programmatically access and control your agents
const { agent } = useAgent({ agentId: "my_agent" });

// Render and update your agent's state
return <div>
  <h1>{agent.state.city}</h1>
  <button onClick={() => agent.setState({ city: "NYC" })}>
    Set City
  </button>
</div>

Check out the useAgent docs to learn more.

CopilotKit.UseAgent.Graphic.Motion_2.mp4

Generative UI

Generative UI is a core CopilotKit pattern that allows agents to dynamically render UI as part of their workflow.

demo-generative-ui.mp4

Compare the Three Types

image

Explore:

Generative UI educational repo โ†’

๐Ÿ–ฅ๏ธ AG-UI: The Agentโ€“User Interaction Protocol

Connect agent workflow to user-facing apps, with deep partnerships and 1st-party integrations across the agentic stackโ€”including LangGraph, CrewAI, and more.

AG-UI


npx create-ag-ui-app my-agent-app
Learn more in the AG-UI README โ†’

๐Ÿค Community

Have questions or need help?

Join our Discord โ†’
Read the Docs โ†’
Try Copilot Cloud โ†’

Stay up to date with our latest releases!

Follow us on LinkedIn โ†’
Follow us on X โ†’

๐Ÿ™‹๐Ÿฝโ€โ™‚๏ธ Contributing

Thanks for your interest in contributing to CopilotKit! ๐Ÿ’œ

We value all contributions, whether it's through code, documentation, creating demo apps, or just spreading the word.

Here are a few useful resources to help you get started:

๐Ÿ“„ License

This repository's source code is available under the MIT License.

About

React UI + elegant infrastructure for AI Copilots, in-app AI agents, AI chatbots, and AI-powered Textareas ๐Ÿช

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 92.4%
  • Python 3.6%
  • CSS 2.2%
  • Other 1.8%