Docs/Hyperagent/Getting Started

Getting Started

Get up and running with Hyperagent. Choose the installation method that best fits your needs.

Prerequisites

Before you begin, ensure you have:

Python 3.10+

Required for backend

Node.js 18.18+

Required for frontend (optional)

API Keys

Google Gemini API key, Thirdweb credentials

Database

PostgreSQL 15+ or Supabase (cloud)

Installation Options

Choose the installation method that works best for you:

Docker

Full stack with all services

Cloud

Supabase + Render deployment

Local

Direct Python installation

Your First Contract

Once installed, generate your first contract using the API:

Terminal

# Generate a contract via API
curl -X POST http://localhost:8000/api/v1/contracts/generate \
  -H "Content-Type: application/json" \
  -d '{
    "nlp_description": "Create a simple ERC20 token contract",
    "contract_type": "token"
  }'

Quick Setup

For the fastest setup, use Docker Compose. It includes PostgreSQL, Redis, and all dependencies configured automatically.

Overview

Docker Setup