> For the complete documentation index, see [llms.txt](https://supersonic-ai.gitbook.io/supersonic-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://supersonic-ai.gitbook.io/supersonic-documentation/for-developers/developer-quick-start.md).

# Developer Quick Start

## Quick Start Guide

Ready to dive into SuperSonic? Awesome! Whether you're here to tinker with the code, build something cool, or just explore what our AI-powered DeFi platform can do, we'll get you up and running in no time.

### Before We Start

You'll need a few things installed:

* **Node.js** (version 23 or newer)
* **pnpm** (our package manager of choice)

  ```bash
  npm install -g pnpm
  ```
* **Git** (for grabbing the code)
* **Some coding know-how** (mainly TypeScript/Node.js basics)

### Let's Get Started!

#### 1. Grab the Code

First, let's clone the repo and hop into the right folder:

```bash
git clone https://github.com/nicoware-dev/supersonic
cd supersonic/eliza
```

#### 2. Install the Good Stuff

```bash
pnpm install --no-frozen-lockfile
```

#### 3. Set Up Your Secret Sauce

Copy our example config file:

```bash
cp .env.example .env
```

Now, add your credentials to the `.env` file:

```env
# Your Sonic essentials
EVM_PRIVATE_KEY=your_private_key
EVM_PROVIDER_URL=https://sonic.drpc.org

# Pick your AI brain
OPENAI_API_KEY=your_openai_api_key
```

#### 4. Build It

```bash
pnpm build
```

#### 5. Fire It Up!

**Want to test just one agent?**

```bash
pnpm start --characters="characters/demo-agent.character.json"
```

**Ready for the whole crew?**

```bash
pnpm start --characters="characters/demo-agent.character.json,characters/metrics-agent.character.json,characters/sales-agent.character.json,characters/meme-agent.character.json,characters/sonic-expert-agent.character.json"
```

#### 6. Launch the Web Interface

Open a new terminal and run:

```bash
cd client
pnpm run dev
```

You'll find your shiny new web interface at `http://localhost:3000` (unless your computer says otherwise).

### What's Next?

#### Explore the Code

Take a peek around the `eliza` directory – that's where all the magic happens.

#### Check Out the Docs

Got questions? Our docs folder is packed with helpful info and tips.

#### Join the Fun

Need a hand or want to chat? Jump into our [Discord](https://discord.gg/dCtktdkt6J) – we're a friendly bunch!

That's it! You're all set to start your SuperSonic journey. Happy building! 🚀


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://supersonic-ai.gitbook.io/supersonic-documentation/for-developers/developer-quick-start.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.