mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
Markus Ecker
036d5412cc
- Move original CopilotKit/CopilotKit directory to src/v1.x - Introduce new v2 interfaces in src/v2.x - Align CI paths and preview environments to new layout Signed-off-by: Tyler Slaton <tyler@copilotkit.ai> Co-authored-by: Ran Shemtov <ran@copilotkit.ai> Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com> Co-authored-by: Mike Ryan <mike.ryan52@gmail.com>
78 lines
3.2 KiB
Plaintext
78 lines
3.2 KiB
Plaintext
---
|
|
description:
|
|
globs:
|
|
alwaysApply: false
|
|
---
|
|
# CopilotKit Quick Reference
|
|
|
|
## Need to...?
|
|
|
|
### Build a Simple Copilot
|
|
- Start with [copilot-chat-with-your-data/](mdc:examples/copilot-chat-with-your-data)
|
|
- Use [react-core/](mdc:src/v1.x/packages/react-core) for basic integration
|
|
- Add [react-ui/](mdc:src/v1.x/packages/react-ui) for pre-built components
|
|
|
|
### Create Multi-Agent Systems
|
|
- Check [coagents-starter/](mdc:examples/coagents-starter) for basic setup
|
|
- Use [coagents-routing/](mdc:examples/coagents-routing) for routing patterns
|
|
- See [coagents-shared-state/](mdc:examples/coagents-shared-state) for state management
|
|
|
|
### Integrate with CrewAI
|
|
- **Crews**: [coagents-starter-crewai-crews/](mdc:examples/coagents-starter-crewai-crews)
|
|
- **Flows**: [coagents-starter-crewai-flows/](mdc:examples/coagents-starter-crewai-flows)
|
|
|
|
### Develop Python Agents
|
|
- Use [sdk-python/](mdc:sdk-python) package
|
|
- Check [copilotkit/agent.py](mdc:sdk-python/copilotkit/agent.py) for main agent class
|
|
- See [coagents-starter/agent-py/](mdc:examples/coagents-starter/agent-py) for example
|
|
|
|
### Develop JavaScript Agents
|
|
- Use [sdk-js/](mdc:src/v1.x/packages/sdk-js) package
|
|
- Check [coagents-starter/agent-js/](mdc:examples/coagents-starter/agent-js) for example
|
|
|
|
### Customize UI Components
|
|
- Browse [registry/](mdc:registry) for reusable components
|
|
- Check [docs/components/react/](mdc:docs/components/react) for documentation
|
|
- Use [react-ui/](mdc:src/v1.x/packages/react-ui) for pre-built components
|
|
|
|
### Set Up Development Environment
|
|
- Review [src/v1.x/package.json](mdc:src/v1.x/package.json) for workspace setup
|
|
- Use scripts in [src/v1.x/scripts/](mdc:src/v1.x/scripts)
|
|
- Check [utilities/](mdc:src/v1.x/utilities) for shared configurations
|
|
|
|
### Run Tests
|
|
- Use [examples/e2e/](mdc:examples/e2e) for end-to-end testing
|
|
- Check [playwright.config.ts](mdc:examples/e2e/playwright.config.ts) for configuration
|
|
|
|
### Build Documentation
|
|
- Check [docs/](mdc:docs) for documentation site
|
|
- Use [docs/snippets/](mdc:docs/snippets) for code examples
|
|
- See [docs/content/docs/](mdc:docs/content/docs) for markdown files
|
|
|
|
## Key Files to Know
|
|
- **[src/v1.x/package.json](mdc:src/v1.x/package.json)** - Main workspace configuration
|
|
- **[sdk-python/pyproject.toml](mdc:sdk-python/pyproject.toml)** - Python SDK configuration
|
|
- **[CopilotKit.code-workspace](mdc:src/v1.x/CopilotKit.code-workspace)** - VS Code workspace settings
|
|
- **[examples/shared/](mdc:examples/shared)** - Shared utilities and templates
|
|
|
|
## Common Patterns
|
|
1. **Frontend**: Next.js app with CopilotProvider and CopilotChat
|
|
2. **Backend**: Python or Node.js agent with actions and state management
|
|
3. **Integration**: Runtime connects frontend to backend agents
|
|
4. **Testing**: Playwright E2E tests for full integration validation
|
|
|
|
## Getting Started Checklist
|
|
1. Clone the repository
|
|
2. Navigate to [src/v1.x/](mdc:src/v1.x) directory
|
|
3. Run `npm install` to set up workspace
|
|
4. Choose an example from [examples/](mdc:examples)
|
|
5. Follow the example's README.md
|
|
6. Start developing your custom copilot or agent
|
|
|
|
## Need Help?
|
|
- Check [CONTRIBUTING.md](mdc:CONTRIBUTING.md) for contribution guidelines
|
|
- Browse [community/](mdc:community) for demos and examples
|
|
- Look at [docs/](mdc:docs) for comprehensive documentation
|
|
|
|
|