Here for Hacktoberfest? 🎉 Get started here 🚀 🎊.

CopilotKit is the open-source framework for integrating powerful AI Copilots into any application. Easily implement custom AI Chatbots, AI Agents, AI Textareas, and more.

👉 Check out the docs at https://docs.copilotkit.ai

Table of Contents

• Getting Started
  • Quickstart & Tutorials
  • Examples & Starter Templates
• Building Blocks
  • Components
  • Hooks
• Contributing
• Get in touch
• License

Getting Started

Quickstart & Tutorials

There are several easy ways to get started with CopilotKit:

• Quickstart: Chatbot: In just two minutes, add an AI Chatbot to your app with the ability to read application state and take actions.
• Tutorial: Todo List Copilot: For a better deep dive into CopilotKit, take a simple todo list app and supercharge it with an AI chat popup.
• Tutorial: Textarea Autocomplete: For a better deep dive into CopilotKit, we'll take a simple email client app and add an AI-powered textarea to it with autocompletions and AI insertions/edits.

Examples & Starter Templates

🕹️ PowerPoint Clone + Copilot https://github.com/CopilotKit/demo-presentation	🕹️ Simple Todo App + Copilot https://github.com/CopilotKit/demo-todo
🕹️ Spreadsheets + Copilot https://github.com/CopilotKit/demo-spreadsheet	🕹️ PowerPoint Clone + Copilot + Voice Control https://github.com/CopilotKit/demo-presentation-voice

Building Blocks

💡 Want to learn more? Check out the CopilotKit Documentation.

🧩 Components

• <CopilotTextarea />: An AI-powered textarea with autocompletions and AI-powered insertions/edits.
• <CopilotPopup />: AI-powered chat floating chat popup component.
• <CopilotSidebar />: AI-powered chat sidebar component.
• <CopilotChat />: AI-powered plain chat component.

⚡️ Hooks

• useCopilotReadable: Provide in-app state and any other information to your Copilot.
• useCopilotAction: Enable your Copilot to perform actions and render custom-generated UI in the chat.
• useCopilotChat: Directly interact with the Copilot chat instance to add messages and manipulate the chat history.
• useCopilotChatSuggestions: Integrate AI-powered chat follow-up suggestions that are aware of your app's state and chat history.

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, check out the contribution guide.
• For documentation-related contributions, check out the documentation Contributions guide.
• Want to contribute but not sure how? Join our Discord and we'll help you out!

💡 NOTE: All contributions must be submitted via a pull request and be reviewed by our team. This is to ensure that all contributions are of high quality and align with the project's goals.

Get in touch

You are welcome to join our Discord and chat with our team and other community members.

Additionally, you can reach out to us at [email protected].

License

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