Walkthrough
This walkthrough explains the core flow and safe first steps.
1) Install and configure
Follow the installation guide to install and create .env
and cc-liquid-config.yaml
.
2) Confirm profile/config/data
See configuration for defaults and overrides: Configuration → DataSet your data source in cc-liquid-config.yaml
or via --set data.source=[crowdcent|numerai]
:
crowdcent
: latest consolidated metamodel from CrowdCentnumerai
: Numerai Crypto metamodellocal
: your own parquet/csv file
3) Inspect account and positions
This shows your current portfolio state:
Warning
Errors on this step are most often due to incrorrectly configured/loaded private keys. You may need to ensure your .env is loaded by running:
This command reads your .env
file, filters out comments, and exports the variables. You'll need to run it in each new terminal session.
4) Plan and execute rebalancing
The CLI will display a detailed plan showing:
- Current vs target positions
- Required trades to rebalance
- Portfolio metrics and leverage
After reviewing the plan, you'll be prompted to confirm execution. To skip the confirmation prompt:
You can adjust parameters on the fly:
cc-liquid rebalance --set portfolio.num_long=12 --set portfolio.num_short=8 --set portfolio.target_leverage=2.0
How rebalancing works
-
Load predictions
- Downloads latest metamodel from CrowdCent/Numerai (or loads local file)
- Keeps most recent prediction per asset
-
Select assets
- Top
num_long
assets for long positions (highest predictions) - Bottom
num_short
assets for short positions (lowest predictions) - Filters to only assets tradeable on Hyperliquid
- Top
-
Size positions
- Equal-weight:
(account_value × target_leverage) / total_positions
- Warns if position sizes fall below
min_trade_value
- Equal-weight:
-
Generate trades
- Calculates delta between current and target positions
- Rounds sizes to exchange precision (
sz_decimals
) - Marks trades below minimum as "skipped"
-
Execute orders
- Places market orders with configured
slippage_tolerance
- Reports fills, failures, and actual slippage
- Places market orders with configured
After execution completes:
Flatten (close all positions)
In the event you want to return your entire portfolio/vault to cash, close-all
plans and executes trades to close all trades to 0 notional value. Add --skip-confirm
to skip confirmation messages.
5) Continuous mode (autopilot)
Schedules execution at portfolio.rebalancing.at_time
every every_n_days
. See Autopilot & Scheduling for details.
Dashboard/monitor view:
Safety notes
- Leverage increases liquidation risk; start with 1.0x
- Ensure
execution.min_trade_value
and slippage are appropriate - Use Hyperliquid testnet first (
--set is_testnet=true
)