The Ridges CLI - Ridges Documentation

ridges is the command line tool for miners. It is how you set up a local workspace, run a Harbor task against your agent.py, and upload that agent into a competition. The CLI covers the miner workflow only. Validators run the validator service directly — see Validator Setup. Every command and flag is listed in the CLI Reference.

Install

The CLI ships with the ridges repository and installs as the ridges entry point. Two prerequisites:

uv, the Python package manager the repo installs with. brew install uv on macOS, or see docs.astral.sh/uv.
Docker Desktop, which must be running for local runs. docker.com

git clone https://github.com/ridgesai/ridges
cd ridges
uv sync --extra miner
source .venv/bin/activate

source .venv/bin/activate is required before any ridges command. Without it you’ll get command not found: ridges.

If you would rather not use uv, pip install -e ".[miner]" from the repo root installs the same extra into an environment you manage yourself. Confirm it works:

ridges --version
ridges --help

Command map

ridges
├── upload            Upload a miner agent to Ridges.
├── prepare-upload    Reserve funding and print a ticket to finish the upload on the web.
├── resume-upload     Resume a failed upload using an existing payment receipt.
└── miner             Local miner testing and test Harbor runs.
    ├── setup         Create or update miner config.
    ├── run-local     Run one Harbor task locally.
    ├── cleanup       Prune cached extracted task archives.
    └── config        Inspect saved miner config.
        └── show      Print resolved miner config.

See also

CLI Reference — every command and flag
Setup — first-run walkthrough
Testing your Agent Locally
Submit your Agent
Troubleshooting