Reference
CLI Reference
Command-line reference for the Hyperliquid intelligence module that powers Axe's perps cockpit.
All commands support both local and remote backends. Set HLQ_BACKEND_URL to use a remote endpoint.
hlq search
Search for traders matching a natural language query.
| Option | Default | Description |
|---|---|---|
--top N | 50 | Maximum results to return |
--format json|table | table | Output format |
--dry-run | off | Compile SQL without executing |
--address 0x... / -a | — | Explicit address to analyze (repeatable) |
Examples:
Supported intent families:
| Intent | Example queries |
|---|---|
similarity | "find BTC traders", "traders like 0x..." |
risk_regime | "high leverage risky traders", "risk regime leverage 4x" |
copy_lag | "copy trading BTC followers", "detect copy lag 3 days" |
anomaly | "anomalous trading behavior on HYPE" |
whale_ranking | "top BTC whale by largest position" |
screening | "low risk consistent active traders" |
counterfactual | "what if trader had used tighter stops" |
strategy_comparison | "strategy comparison between traders" |
help | "what kinds of queries can I run?" |
hlq trader
Get trader profile and analysis.
| Option | Default | Description |
|---|---|---|
--window 30d | 30d | Analysis window |
--format | table | Output format |
hlq copytrade detect
Detect copy-trading relationships.
| Option | Default | Description |
|---|---|---|
--leader 0x... | — | Leader address |
--follower 0x... | — | Follower address |
--lag 1d | 1d | Lag window |
--format | table | Output format |
--dry-run | off | Compile SQL without executing |
Example:
hlq risk screen
Screen traders by risk criteria.
| Option | Default | Description |
|---|---|---|
--type | leverage | Risk type (leverage, liquidation, margin) |
--threshold | 4.0 | Risk threshold value |
--format | table | Output format |
hlq bridge status
Show bridge health, version, and artifact checksums.
Returns: version, format version, created date, action/ANN/template counts, checksum status, health verdict with narrative.
hlq schema
Print JSON schema for agent self-discovery.
Returns tool definitions suitable for LLM function-calling integration.