CopilotKit <> LlamaIndex Starter

This is a starter template for building AI agents using LlamaIndex 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 18+
• Python 3.9+
• OpenAI API Key (for the LlamaIndex agent)
• uv
• Any of the following package managers:
  • npm (default)
  • pnpm
  • yarn
  • bun

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

This also installs the Python agent dependencies via uv sync.

2. Set up your OpenAI API key:

export OPENAI_API_KEY="your-openai-api-key-here"

3. 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:debug - Starts development servers with debug logging enabled
• dev:ui - Starts only the Next.js UI server
• dev:agent - Starts only the LlamaIndex agent server
• install:agent - Installs Python dependencies for the agent
• build - Builds the Next.js application for production
• start - Starts the production server
• lint - Runs ESLint for code linting

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

📚 Documentation

• LlamaIndex Documentation - Learn more about LlamaIndex and its features
• CopilotKit Documentation - Explore CopilotKit's capabilities
• Next.js Documentation - Learn about Next.js features and API
• YFinance Documentation - Financial data tools

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 LlamaIndex agent is running on port 9000
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