mirror of
https://github.com/CopilotKit/CopilotKit.git
synced 2026-09-14 16:26:20 +08:00
copilotkit-qa-bot
185 lines
5.0 KiB
Markdown
185 lines
5.0 KiB
Markdown
# CopilotKit <> strands Starter
|
|
|
|
This is a starter template for building AI agents using [strands](https://strands.com) and [CopilotKit](https://copilotkit.ai). It provides a modern Next.js application with an integrated investment analyst agent that can research stocks, analyze market data, and provide investment insights.
|
|
|
|
## Prerequisites
|
|
|
|
- Node.js 20+
|
|
- Python 3.12+
|
|
- [uv](https://docs.astral.sh/uv/) (Python package manager)
|
|
- OpenAI API Key (for the strands agent)
|
|
- Any of the following package managers:
|
|
- npm (default)
|
|
- [pnpm](https://pnpm.io/installation)
|
|
- [yarn](https://classic.yarnpkg.com/lang/en/docs/install/)
|
|
- [bun](https://bun.sh/)
|
|
|
|
## Getting Started
|
|
|
|
1. Install dependencies using your preferred package manager:
|
|
|
|
```bash
|
|
# Using npm (default)
|
|
npm install
|
|
|
|
# Using pnpm
|
|
pnpm install
|
|
|
|
# Using yarn
|
|
yarn install
|
|
|
|
# Using bun
|
|
bun install
|
|
```
|
|
|
|
> **Note:** Installing the package dependencies will also install the agent's python dependencies via the `install:agent` script.
|
|
|
|
2. Set up your OpenAI API key:
|
|
|
|
```bash
|
|
export OPENAI_API_KEY="your-openai-api-key-here"
|
|
```
|
|
|
|
or create a `.env` file.
|
|
|
|
```bash
|
|
echo "OPENAI_API_KEY=your-openai-api-key-here" > .env
|
|
```
|
|
|
|
3. Start the development server:
|
|
|
|
```bash
|
|
# Using npm (default)
|
|
npm run dev
|
|
|
|
# Using pnpm
|
|
pnpm dev
|
|
|
|
# Using yarn
|
|
yarn dev
|
|
|
|
# Using bun
|
|
bun run dev
|
|
```
|
|
|
|
This will start both the UI and agent servers concurrently.
|
|
|
|
## CopilotKit Intelligence & Threads (Optional)
|
|
|
|
CopilotKit Intelligence provides durable, multi-turn conversation threads with memory persistence. To enable:
|
|
|
|
### Prerequisites
|
|
|
|
- Docker Desktop or equivalent
|
|
- CopilotKit License Token (get from [CopilotKit Cloud](https://cloud.copilotkit.ai))
|
|
- **Intelligence Repository** - Clone the [CopilotKit Intelligence](https://github.com/CopilotKit/Intelligence) repository locally
|
|
|
|
### Setup
|
|
|
|
1. Clone the Intelligence repository (if not already cloned):
|
|
|
|
```bash
|
|
# Clone to a sibling directory (recommended)
|
|
cd ..
|
|
git clone https://github.com/CopilotKit/Intelligence.git
|
|
cd -
|
|
```
|
|
|
|
2. Start the intelligence stack:
|
|
|
|
```bash
|
|
# Set your license token (if not already in .env)
|
|
echo "COPILOTKIT_LICENSE_TOKEN=your-token-here" >> .env
|
|
|
|
# Set the path to your Intelligence repo checkout
|
|
# Default: ../../../Intelligence (assumes CopilotKit monorepo layout)
|
|
# For standalone starters, adjust to your actual path:
|
|
export INTELLIGENCE_REPO=../Intelligence # if cloned as sibling
|
|
|
|
# Start intelligence services (postgres, redis, intelligence API)
|
|
docker compose -f docker-compose.intelligence.yml up -d
|
|
|
|
# Verify services are healthy
|
|
docker compose -f docker-compose.intelligence.yml ps
|
|
```
|
|
|
|
3. Ensure intelligence configuration in `.env` (uncomment if already present):
|
|
|
|
```bash
|
|
COPILOTKIT_LICENSE_TOKEN=your-token-here
|
|
INTELLIGENCE_API_URL=http://localhost:4201
|
|
INTELLIGENCE_GATEWAY_WS_URL=ws://localhost:4401
|
|
```
|
|
|
|
4. Run your application:
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
The intelligence stack will now handle conversation threads, state persistence, and memory. See `docker-compose.intelligence.yml` and `docker/01-create-databases.sql` for configuration details.
|
|
|
|
> **Note:** The Intelligence service is built from source and requires the Intelligence repository. If you're using this as a standalone starter (extracted from the CopilotKit monorepo), you must clone the Intelligence repo separately and set `INTELLIGENCE_REPO` to point to it.
|
|
|
|
### Stopping Intelligence
|
|
|
|
```bash
|
|
# Stop services (keeps data)
|
|
docker compose -f docker-compose.intelligence.yml stop
|
|
|
|
# Stop and remove containers + volumes (fresh start)
|
|
docker compose -f docker-compose.intelligence.yml down -v
|
|
```
|
|
|
|
## Available Scripts
|
|
|
|
The following scripts can also be run using your preferred package manager:
|
|
|
|
- `dev` - Starts both UI and agent servers in development mode
|
|
- `dev:ui` - Starts only the Next.js UI server
|
|
- `dev:agent` - Starts only the strands agent server
|
|
- `build` - Builds the Next.js application for production
|
|
- `start` - Starts the production server
|
|
- `install:agent` - Installs Python dependencies for the agent
|
|
|
|
## 📚 Documentation
|
|
|
|
The main UI component is in `src/app/page.tsx`. You can:
|
|
|
|
- Modify the theme colors and styling
|
|
- Add new frontend actions
|
|
- Customize the CopilotKit sidebar appearance
|
|
|
|
Otherwise, check out the documentation relevant to your task:
|
|
|
|
- [Strands Documentation](https://strandsagents.com/latest/documentation/docs/) - Learn more about Strands and its features
|
|
- [CopilotKit Documentation](https://docs.copilotkit.ai) - Explore CopilotKit's capabilities
|
|
- [Next.js Documentation](https://nextjs.org/docs) - Learn about Next.js features and API
|
|
|
|
## Contributing
|
|
|
|
Feel free to submit issues and enhancement requests! This starter is designed to be easily extensible.
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the LICENSE file for details.
|
|
|
|
## Troubleshooting
|
|
|
|
### Agent Connection Issues
|
|
|
|
If you see "I'm having trouble connecting to my tools", make sure:
|
|
|
|
1. The strands agent is running on port 8000
|
|
2. Your OpenAI API key is set correctly
|
|
3. Both servers started successfully
|
|
|
|
### Python Dependencies
|
|
|
|
If you encounter Python import errors:
|
|
|
|
```bash
|
|
cd agent
|
|
uv sync
|
|
```
|