Skip to content

README.md

Latest commit

 

History

History
117 lines (78 loc) · 2.88 KB

README.md

File metadata and controls

117 lines (78 loc) · 2.88 KB

CopilotKit <> strands Starter

This is a starter template for building AI agents using strands and CopilotKit. 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 (Python package manager)
  • OpenAI API Key (for the strands agent)
  • Any of the following package managers:

Getting Started

  1. Install dependencies using your preferred package manager:
# 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.

  1. Set up your OpenAI API key:
export OPENAI_API_KEY="your-openai-api-key-here"

or create a .env file.

echo "OPENAI_API_KEY=your-openai-api-key-here" > .env
  1. Start the development server:
# 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.

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:

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:

cd agent
uv sync