Quick Start Guide

aikyo is a framework for building AI companions that interact peer-to-peer.

1 Setup

1.1 Clone the Template

git clone https://github.com/akazdayo/aikyo-template.git
cd aikyo-template
pnpm install

1.2 Configure Environment Variables

By default, Anthropic is set, but you can also use other API providers by editing the companion card.

echo "ANTHROPIC_API_KEY=sk-ant-..." > .env

2 Run the Application

pnpm run dev

$ pwd
/home/akazdayo/projects/aikyo-template

$ cat example_request.json | jq -cM . | websocat ws://localhost:8080