All pages
Powered by GitBook
1 of 1

Loading...

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

  2. Enter the Directory

  3. Switch to the Latest Tagged Release

  4. Install Dependencies


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:

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


Build the Local Libraries


Configure the Environment

  1. Copy the Example Environment File

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


Choose Your AI Model

Cyne AI supports multiple AI model configurations:

  1. OpenAI:

    • Set the model in .env:

  2. Custom Models:


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:


Open the Chat Interface

  1. Open your browser to:

    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:


Additional Integrations

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

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


Optional: GPU Acceleration

If you have an NVIDIA GPU, follow these steps:

  1. Install CUDA Support:

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


Basic Usage Examples

  1. Start the Chat Interface

  2. Run Multiple Agents


Common Issues & Solutions

  1. Node.js Version

    • Ensure Node.js 23+ is installed.

    • Check your version:

  2. Sharp Installation Errors


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!

Define model parameters in the agent.json file.
Start the Agent
  • Run Multiple Agents

  • Install with:

  • CUDA Setup Issues

    • Verify your GPU compatibility with the CUDA Toolkit.

  • pnpm start --characters="characters/whale_tracker.character.json,characters/staking_agent.character.json"
    pnpm install --include=optional sharp
    git clone https://github.com/cyne-app/cyne
    cd cyne
    git checkout $(git describe --tags --abbrev=0)
    pnpm install --no-frozen-lockfile
    pnpm install --no-frozen-lockfile
    pnpm build
    cp .env.example .env
    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
    CYNE_MODEL=gpt-4o  
    OR  
    CYNE_MODEL=gpt-4  
    characters/whale_tracker.character.json
    characters/risk_manager.character.json
    http://localhost:5173/
    DISCORD_API_TOKEN=your_discord_bot_token  
    DISCORD_APPLICATION_ID=your_discord_application_id
    MAGICEDEN_API_KEY=your_api_key
    JUPITER_API_KEY=your_api_key
    npx --no node-llama-cpp source download --gpu cuda
    pnpm start
    pnpm start --characters="characters/whale_tracker.character.json,characters/liquidity_manager.character.json"
    node -v
    pnpm start --character="characters/whale_tracker.character.json"