Skip to content

Getting Started

Prerequisites

  • Python 3.11+
  • uv package manager
  • Hyperliquid API credentials
  • OpenAI API key (or compatible LLM provider)

Installation

  1. Clone the repository:
bash
git clone https://github.com/timbrinded/degen-ai.git
cd hyperliquid-trading-agent
  1. Install dependencies using uv:
bash
uv sync
  1. Copy the example configuration:
bash
cp config.toml.example config.toml
  1. Configure your API keys and settings in config.toml

Basic Configuration

Edit config.toml with your credentials:

toml
[hyperliquid]
private_key = "your_private_key_here"
testnet = true  # Start with testnet

[llm]
provider = "openai"
api_key = "your_openai_key"
model = "gpt-4"

[agent]
check_interval_seconds = 300
max_position_size_usd = 1000

See the Configuration Guide for detailed options.

Running the Agent

Standard Mode

bash
uv run python -m hyperliquid_agent.cli run

With Governance

bash
uv run python -m hyperliquid_agent.cli run --governed

Backtesting

bash
uv run python -m hyperliquid_agent.backtesting.cli backtest \
  --symbol BTC \
  --start-date 2024-01-01 \
  --end-date 2024-12-31

Next Steps