Quickstart
This page walks through the most common Neleus workflows, from zero-install market analysis to running a live strategy on Hyperliquid.
Market Commands (No Project Required)
These commands work immediately after installation, with no project setup needed:
# Search for any market by name
neleus market search BTC --scope all-perps
# List all perpetual markets
neleus market list --scope perps
# List HIP-3 markets on a specific DEX
neleus market list --scope hip3 --dex flx
# Analyze a single market with TA indicators
neleus market analyze BTC-PERP --timeframe 1h --lookback-bars 200
# Analyze a HIP-3 market using only the coin name
neleus market analyze GAS --scope hip3 --dex flx
# Rank markets by technical score
neleus market scan --scope perps --max-markets 20
# Stream a live L2 order book
neleus market book BTC-PERP
neleus market book flx:GAS-PERP # HIP-3 market
All market commands default to Hyperliquid mainnet. Add --testnet to use testnet:
Create A Project
A project is a directory containing neleus.toml, one or more strategy files, and optionally a .env file with credentials.
Minimal project
With live trading credentials
neleus new my_bot \
--private-key 0xYOUR_PRIVATE_KEY \
--account-address 0xYOUR_WALLET_ADDRESS
cd my_bot
The keys are written to .env only — never to neleus.toml.
With database monitoring
neleus new my_bot \
--db-backend postgres \
--db-dsn postgresql://user:password@localhost:5432/neleus \
--trade-monitoring
cd my_bot
neleus db init
With credentials and database
neleus new my_bot \
--private-key 0xYOUR_PRIVATE_KEY \
--account-address 0xYOUR_WALLET_ADDRESS \
--db-backend postgres \
--db-dsn postgresql://user:password@localhost:5432/neleus \
--trade-monitoring
cd my_bot
neleus db init
Backtest A Strategy
Fetches Hyperliquid candles and runs the strategy through the Rust backtest engine. No credentials needed.
Run The Strategy (Paper Mode)
Fetch real market data and see what orders the strategy would generate — without submitting anything to the exchange:
# One-shot
neleus run --mode once --strategy momentum
# Daemon (polls every poll_interval_seconds)
neleus run --mode daemon --strategy momentum
This is the safe development mode. Use it to verify your strategy logic before going live.
Run The Strategy Live
--live activates real order execution via HyperliquidTrader. The private key is read from .env or the HYPERLIQUID_SIGNER_PRIVATE_KEY environment variable.
Always test on testnet first
Make sure your testnet wallet has funds. Hyperliquid testnet faucet: https://app.hyperliquid-testnet.xyz/drip
Run live on mainnet — one shot
Run live on mainnet — continuous
The daemon polls for new candles every poll_interval_seconds (default 60). Each time the strategy emits an order, it is submitted to Hyperliquid immediately.
Set Up Credentials After Scaffolding
If you created the project without --private-key, set credentials manually:
cp .env.example .env
# then edit .env:
HYPERLIQUID_SIGNER_PRIVATE_KEY=0xYourKey
HYPERLIQUID_ACCOUNT_ADDRESS=0xYourAddress
HYPERLIQUID_TESTNET=false
Or export them in your shell:
Database-Backed Trade Monitoring
When your project has database.trade_monitoring = true and a valid DSN, every order generated by the strategy is automatically recorded to the hl_orders table — no strategy-level code changes required.
In live mode, orders are submitted to the exchange first, then recorded to the database.