Skip to content

auralshin/neleus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Neleus logo

Neleus

Trade Hyperliquid from the terminal.

A Hyperliquid-first CLI and Python toolkit powered by a Rust core. Search markets, run technical scans, stream live order books, backtest strategies, and scaffold Python trading projects.

Website · Docs · GitHub

Rust Core CLI Venue

What Neleus Does

Workflow What You Get
Market discovery Search and list Hyperliquid spot, default perps, and HIP-3 markets
Technical analysis Single-market reads with RSI, trend, momentum, support, and resistance
Market scanning Ranked terminal scans across a bounded set of markets
Live monitoring Real-time L2 order book view from the Rust WebSocket path
Strategy development Python project scaffolding with a Rust-backed runtime
Backtesting Run strategy backtests against Hyperliquid market data

Quick Start

python3 -m venv .venv
source .venv/bin/activate

pip install maturin
cd python
maturin develop --release
pip install -e .

No project is required for the market-facing commands:

neleus about
neleus market search TSLA --scope hip3
neleus market analyze GAS --scope hip3 --dex flx
neleus market scan --scope perps
neleus market book flx:GAS-PERP

When you want to write strategy code:

neleus new my_strategy_project
cd my_strategy_project

neleus backtest --strategy momentum
neleus run --mode once --strategy momentum
neleus run --mode daemon --strategy momentum

CLI Highlights

neleus about
neleus market search <query>
neleus market list --scope perps|hip3|all-perps|spot
neleus market analyze <symbol> [--scope ...] [--dex ...]
neleus market scan --scope perps|hip3|all-perps|spot
neleus market book <symbol> [--scope ...] [--dex ...]
neleus new <name>
neleus init
neleus backtest
neleus run --mode once|daemon
neleus strategy list|new|show
neleus db status
neleus db init
neleus info

Documentation

The full usage guides live in docs/index.md and are deployed to GitHub Pages.

Run the docs locally:

pip install -r docs/requirements.txt
mkdocs serve

Build the static site:

mkdocs build

The docs cover:

  • installation and local setup
  • no-project CLI workflows
  • simple market search across perps, HIP-3, and spot
  • market search, list, analysis, scan, and live order book usage
  • HIP-3 routing details for commands like neleus market analyze GAS --scope hip3 --dex flx
  • project scaffolding and strategy commands
  • runtime and backtesting
  • configuration, database adapters, and Hyperliquid usage notes

Current Scope

Implemented now:

  • no-project market search, listing, analysis, scans, and live order book monitoring
  • Python project scaffolding
  • strategy backtesting
  • one-shot and daemon strategy runtimes
  • database-backed runtime order/fill monitoring through TradeMonitor
  • database schema inspection and initialization through neleus db status and neleus db init

Not implemented yet:

  • a dedicated neleus trade command separate from the current runtime/core APIs
  • broader live operations tooling beyond the current trade-monitoring path

Links