diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..31f61bd --- /dev/null +++ b/README.en.md @@ -0,0 +1,256 @@ +
+ +FavIcon + +# CopilotKit + +
+ +[Docs](https://docs.copilotkit.ai/?ref=github_readme) · +[Examples](https://www.copilotkit.ai/examples) · +[Enterprise Intelligence Platform](https://go.copilotkit.ai/enterprise-intelligence-platform) · +[Discord](https://discord.gg/6dffbvGU3D?ref=github_readme) + +
+ +Build **agent-native applications** — on any framework, on any surface. + +Generative UI, shared state, and human-in-the-loop workflows for React, Angular, Vue, React Native — and beyond the browser. + +
+ +[![CopilotKit](https://github.com/user-attachments/assets/aeb56c28-c766-44a5-810c-5d999bb6a32a)](https://go.copilotkit.ai/copilotkit-docs) + +
+ + NPM + + + + License: MIT + + + + Discord + +
+
+
+ + + +
+
+ CopilotKit%2FCopilotKit | Trendshift + + + + + +
+ +--- + +## What is CopilotKit + +CopilotKit is a best-in-class SDK for building full-stack agentic applications, Generative UI, and chat applications. + +What started as a React library is now a **multi-platform agentic framework**: the same agent can power your web app, your mobile app, and your team's Slack workspace. + +We are the company behind the **[AG-UI Protocol](https://github.com/ag-ui-protocol/ag-ui)** - adopted by Google, LangChain, AWS, Microsoft, Mastra, PydanticAI, and more! + +## Quick Start + +Up and running in under five minutes. All you need is an LLM key (OpenAI, Anthropic, Gemini, etc.). + +```bash +npx copilotkit@latest create +``` + +## Agent Skills + +CopilotKit ships [agent skills](https://docs.copilotkit.ai) that teach your coding agent (Claude Code, Codex, Cursor, Gemini, and others) how to set up, build with, integrate, debug, and upgrade CopilotKit. + +Install them into any project directory: + +```bash +npx copilotkit@latest skills install +``` + +Run it again any time to refresh to the latest skills. + +## Bring Your App to Life + +https://github.com/user-attachments/assets/72b7b4f3-b6e7-460c-a932-5746fe3c8db3 + +
Add AI to your app in 1 minute
+ +**Features:** + +- **Chat UI** – A fully customizable 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. +- **Self-Learning** _(early access)_ – Agents that continuously improve from user feedback via in-context reinforcement learning (CLHF). + +## 🧩 Works With Your Stack + +One agent backend. Every frontend. + +| Platform | Status | Get Started | +| ------------------------------------------- | ------------ | ----------------------------------------------------------------------------------------------------------- | +| ⚛️ React / Next.js | ✅ GA | [Quickstart](https://docs.copilotkit.ai/built-in-agent/quickstart) | +| 🅰️ Angular | ✅ Supported | [Source Code - Quickstart coming soon](https://github.com/CopilotKit/CopilotKit/tree/main/packages/angular) | +| 💚 Vue | ✅ Supported | [Source Code - Quickstart coming soon](https://github.com/CopilotKit/CopilotKit/tree/main/packages/vue) | +| 📱 React Native | ✅ Supported | [Quickstart](https://docs.copilotkit.ai/react-native) | +| 💬 Slack / MS Teams / Discord / Google Chat | 🟡 Beta | [Request early access](https://go.copilotkit.ai/beyond-the-web-form) | + +Your agent logic stays the same — AG-UI handles the wire protocol, CopilotKit handles the UI layer for each framework. + +## 💬 Beyond the Browser: Slack & Microsoft Teams (Discord, Google Chat coming soon...) + +Your agents can run and generate Generative UI beyond the web app (**[Learn more](https://www.copilotkit.ai/integrations)**). + +CopilotKit now lets you deploy the **same agent** to the places your users already work: + +- **Slack** – Agents as first-class Slack apps: threads, tool calls, and human-in-the-loop approvals right in the channel. +- **Microsoft Teams** – Bring agentic workflows to the enterprise, where your org already lives. + +🔒 **Early access:** We're onboarding teams now. + +👉 **[Request early access →](https://go.copilotkit.ai/beyond-the-web-form)** + +## 🧠 Self-Learning Agents + +Improve your product by learning over time. + +With **Continuous Learning from Human Feedback (CLHF)**, part of the [CopilotKit Intelligence Platform](https://www.copilotkit.ai/copilotkit-intelligence), agents improve with every interaction: + +- **In-context reinforcement learning** – Agents automatically improve from user interactions, no model fine-tuning required. +- **Automatic prompt augmentation** – Agent behavior adapts based on recent interactions and outcomes. +- **Per-user adaptation** – Agents learn individual preferences and get better for each user over time. +- **Threads & persistence** – Full interaction history — generative UI, human-in-the-loop, shared state — captured across sessions. + +Available via CopilotKit Cloud or self-hosted. + +🔒 **Early access:** We're onboarding teams now. + +👉 **[Request early access →](https://go.copilotkit.ai/beyond-the-web-form)** + +https://github.com/user-attachments/assets/7372b27b-8def-40fb-a11d-1f6585f556ad + +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 →](https://docs.copilotkit.ai/langgraph/quickstart) + +## How it works: + +CopilotKit connects your UI, agents, and tools into a single interaction loop. + +![CopilotKit Diagram — Motion x2 6 sec version](https://github.com/user-attachments/assets/6f175d86-bd22-4c26-a13a-6013654ed542) + +This enables: + +- Agents that ask users for input +- Tools that render UI +- Stateful workflows across steps and sessions +- One agent, deployed across web, mobile, and chat platforms + +## ⭐️ useAgent Hook + +The `useAgent` hook sits directly on AG-UI, giving you full programmatic control over the agent connection. + +```ts +// Programmatically access and control your agents +const { agent } = useAgent({ agentId: "my_agent" }); + +// Render and update your agent's state +return
+

{agent.state.city}

+ +
+``` + +Check out the [useAgent docs](https://go.copilotkit.ai/useagent-docs) to learn more. + +https://github.com/user-attachments/assets/67928406-8abc-49a1-a851-98018b52174f + +## Generative UI + +Generative UI is a core CopilotKit pattern that allows agents to dynamically render UI as part of their workflow. + +https://github.com/user-attachments/assets/3cfacac0-4ffd-457a-96f9-d7951e4ab7b6 + +### Compare the Three Types + +image + +#### Explore: + +- [Static (AG-UI Protocol)](https://docs.copilotkit.ai/ag-ui-protocol) +- [Declarative (A2UI)](https://docs.copilotkit.ai/generative-ui/specs/a2ui#using-a2ui-with-copilotkit) +- [Open-Ended (MCP Apps & Open JSON)](https://docs.copilotkit.ai/generative-ui/specs/mcp-apps) + +[Generative UI educational repo →](https://github.com/CopilotKit/CopilotKit/tree/main/examples/showcases/generative-ui) + +## 🖥️ AG-UI: The Agent–User Interaction Protocol + +Connect agent workflows to user-facing apps, with deep partnerships and 1st-party integrations across the agentic stack—including LangChain, CrewAI, Mastra, PydanticAI, and more. + +[![AG-UI](https://github.com/user-attachments/assets/a625237a-cfc1-45fc-8d0c-637316b81291)](https://go.copilotkit.ai/ag-ui) + +--- + +``` +npx create-ag-ui-app my-agent-app +``` + + + Learn more in the AG-UI README → + + +## 🤝 Community + +- [What's New](https://docs.copilotkit.ai/whats-new) +

Have questions or need help?

+ + Join our Discord → +
+ + Read the Docs → +
+ + Try the Enterprise Intelligence Platform → + +

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: + +- For code contributions, [CONTRIBUTING.md](./CONTRIBUTING.md). +- For documentation-related contributions, [check out the documentation contributions guide](https://docs.copilotkit.ai/contributing/docs-contributions?ref=github_readme). + +- Want to contribute but not sure how? [Join our Discord](https://discord.gg/6dffbvGU3D) and we'll help you out! + +## 📄 License + +This repository's source code is available under the [MIT License](https://github.com/CopilotKit/CopilotKit/blob/main/LICENSE).