⭐Quick Start

Prerequisites:

Before getting started with SONA, ensure you have:

• Node.js 23+ (using nvm is recommended)

• pnpm 9+

• Git for version control

• A code editor (VS Code, Cursor or VSCodium recommended)

• Python (mainly for installing NPM)

• (Optional) FFmpeg (for audio/video handling)

• (Optional) CUDA Toolkit (for GPU acceleration)

On Windows? See here before continuing to make life easier: WSL setup guide

Automated Installation:

1. Use https://github.com/tars-sol/sona

git clone [email protected]/tars-sol/sona.git
cd sona
cp .env.example .env
pnpm i && pnpm build && pnpm start

1. Use the start script

// after cloning and cd
./scripts/start.sh

1. Using Docker

Prerequisites:

• A Linux-based server (Ubuntu/Debian recommended)

• Git installed

• Docker

// after cloning and cd
docker-compose build
docker-compose up

Note: If you get permission issues run the docker-compose commands with sudo or add yourself to the docker group

Start SONA:

SONA derived it's character and lore capabilities from ElizaOS. So in order to start your agent, you can provide your character.json file.

pnpm start --character="characters/deep-thought.character.json"

By default agent will be accessible via CLI and APIs too.

Additional Config:

Add plugins and protocols:

{
    "name": "Rainmaker",
    "protocols": ["uniswap", "raydium"],
    // ... other config options
    "plugins": ["@sona/plugin-limit-order"],
}

There are two ways to get a list of available plugins:

1. Web Interface

Go https://github.com/tars-sol/sona/registry/ or the Showcase and search for plugins

1. CLI Interface

npx elizaos plugins list

Plugin Name
@sona/plugin-limit-order
@sona/plugin-swap-evm
@sona/plugin-swap-raydium
@sona/plugin-trade-pumpfun
@sona/plugin-dex-liquidity
@sona/plugin-oracle-prices