Quickstart Guide

The CYNE AI repository will be made publicly accessible at the end of Q1. Once it's available, follow these steps to set up your development environment

Installation

Clone and Install

The Cyne AI repository will be made publicly accessible by the end of Q1. Once available, follow these steps to set up your development environment:

1. Clone the Repository

   git clone https://github.com/cyne-app/cyne

2. Enter the Directory

   cd cyne

3. Switch to the Latest Tagged Release

   git checkout $(git describe --tags --abbrev=0)

4. Install Dependencies

   pnpm install --no-frozen-lockfile

---

Important Note on pnpm Lockfile Management

By default, the pnpm lockfile will not be updated during installations due to .npmrc settings (frozen-lockfile=true). To update the lockfile:

pnpm install --no-frozen-lockfile

Use this command only when initializing the repository, bumping package versions, or adding new packages.

---

Build the Local Libraries

pnpm build

---

Configure the Environment

1. Copy the Example Environment File

   cp .env.example .env

2. Edit .env and Add Your Values Example variables to configure:

   DISCORD_APPLICATION_ID=  # For Discord integration
   DISCORD_API_TOKEN=       # Bot token
   OPENAI_API_KEY=          # OpenAI API key
   SOLANA_RPC_URL=          # RPC endpoint for Solana
   MAGICEDEN_API_KEY=       # API key for NFT marketplace access
   JUPITER_API_KEY=         # Jupiter integration for DEX aggregator

---

Choose Your AI Model

Cyne AI supports multiple AI model configurations:

1. OpenAI:

   • Set the model in .env:

     CYNE_MODEL=gpt-4o  
     OR  
     CYNE_MODEL=gpt-4  

2. Custom Models:

   • Define model parameters in the agent.json file.

---

Create Your First Agent

1. Create a Character File

   • Navigate to the characters directory.

   • Use the provided default.character.json as a template to customize your agent's personality and functionality. Example paths:

   characters/whale_tracker.character.json
   characters/risk_manager.character.json

2. Start the Agent

   pnpm start --character="characters/whale_tracker.character.json"

3. Run Multiple Agents

   pnpm start --characters="characters/whale_tracker.character.json,characters/staking_agent.character.json"

---

Open the Chat Interface

1. Open your browser to:

   http://localhost:5173/

   Begin interacting with your agent.

---

Platform Integration

Discord Bot Setup

1. Create a bot in the Discord Developer Portal.

2. Add the bot to your server using the OAuth2 URL generator.

3. Add these values to .env:

   DISCORD_API_TOKEN=your_discord_bot_token  
   DISCORD_APPLICATION_ID=your_discord_application_id

---

Additional Integrations

1. Magic Eden Integrate with the Magic Eden NFT marketplace:

   MAGICEDEN_API_KEY=your_api_key

2. Jupiter DEX Aggregator For seamless token swaps and DeFi operations:

   JUPITER_API_KEY=your_api_key

---

Optional: GPU Acceleration

If you have an NVIDIA GPU, follow these steps:

1. Install CUDA Support:

   npx --no node-llama-cpp source download --gpu cuda

2. Ensure that CUDA Toolkit, cuDNN, and cuBLAS are installed.

---

Basic Usage Examples

1. Start the Chat Interface

   pnpm start

2. Run Multiple Agents

   pnpm start --characters="characters/whale_tracker.character.json,characters/liquidity_manager.character.json"

---

Common Issues & Solutions

1. Node.js Version

   • Ensure Node.js 23+ is installed.

   • Check your version:

     node -v

2. Sharp Installation Errors

   • Install with:

     pnpm install --include=optional sharp

3. CUDA Setup Issues

   • Verify your GPU compatibility with the CUDA Toolkit.

---

Next Steps

1. 🤖 Create Your First Agent

2. 📝 Customize Agent Personalities

3. ⚡ Add Advanced Features

For detailed guides, troubleshooting, and more, visit our Full Documentation. Join our Discord Community for support and updates!