Tidal Docs¶
Tidal is Yearn's auction operations stack. It scans strategy and fee-burner inventories, caches balances and prices in SQLite, exposes that state through a FastAPI control plane, and lets CLI clients prepare and broadcast auction transactions with local wallet signing.
Start Here¶
- Most users: Install then CLI Client Guide
- Running the shared server: Install then Server Operator Guide
- Developing from source: Install then Local Development
Docs Map¶
- Setup and first-day workflows: Install, CLI Client Guide, Server Operator Guide
- Exact command docs: CLI Command Map
- Runtime files and settings: Configuration
- System behavior: Architecture, Pricing, Kick Selection
- HTTP surface: API Reference
Source Of Truth¶
These docs are meant to explain the current system, not preserve historical plans. When behavior disagrees with prose, prefer the code:
- CLI surface:
tidal --helpandtidal-server --help - API surface: FastAPI routes in
tidal/api/routes/ - Config schema:
tidal/config.py