[End User Hub]
Trader-facing documentation — getting started, concepts, guides, tutorials, and reference.
Hoox is a free, open-source, edge-native algorithmic trading framework and automation engine deployed natively to the Cloudflare® Edge Network. By utilizing a distributed microservice architecture, Hoox processes trade signals, evaluates risk parameters, executes order routing, and fires Telegram notifications—all within milliseconds and directly from the edge nodes closest to exchange servers.
Choose Your Path
Whether you are a retail algorithmic trader setting up your first automated TradingView strategies, a quantitative analyst exploring low-latency DeFi order routing, or a DevOps engineer maintaining multi-exchange infrastructure, our docs are split into highly focused tracks:
1. Getting Started
If you are brand new to the Hoox ecosystem, start here to prepare your machine, provision resources, and deploy your first live microservice in under 5 minutes:
- Core Installation — Provision prerequisites (Bun runtime, Cloudflare credentials) and bootstrap a project.
- Platform Configuration — Declaratively define environment variables, JSON profile templates, and KV keys.
- 5-Minute Quick Start — Launch local worker runners and execute a simulated webhook trade signal.
2. Core Concepts
Understand the underlying technology, low-latency edge architecture, and security layers that protect your api keys:
- How Hoox Works — The end-to-end lifecycle of a trade signal from webhook alert to order confirmation.
- Edge-First Architecture — Why V8 isolates and Cloudflare Workers outperform traditional VPS architectures by 30-60%.
- Cloudflare Services Map — How D1, KV, R2, Queues, Vectorize, and Browser Rendering are integrated.
- Idempotency & Durable Objects — Preventing catastrophic double-execution and race conditions during high-frequency events.
- Signals & Trade Routing — How parameters map from webhook JSON schemas to live exchange payloads.
- AI Risk Manager — The 5-minute autonomous risk scanner, trailing-stop mathematician, and account kill-switch.
3. Operational Guides
Practical runbooks and blueprints for daily operations, local development, and system health maintenance:
- Local Dev & Workspaces — Run, hot-reload, and test workers locally via Bun or Docker container stacks.
- Terminal UI Operations — Launch and navigate the full-screen 9-view operations cockpit (
./hoox-tui). - Edge Database Operations — Manage global SQLite schemas, track drizzle migrations, and run D1 queries.
- Secrets & Network Security — Secure Cloudflare Zero Trust corridors and encrypt sensitive API credentials.
- Infrastructure Management — Spin up and inspect KV, Queues, R2, and Vectorize indexes in one command.
- Deploying to Production — Roll out code, bind V8 isolates, and deploy Next.js dashboard consoles.
- Self-Healing & Repair — Diagnose connection dropouts, rotate API keys, and run interactive system repair tools.
4. Step-by-Step Tutorials
Follow guided, end-to-end tutorials to integrate your trade sources and notification handlers:
- TradingView Webhook Integration — Write customized Pine Script v5 indicators that ping the Hoox webhook receiver.
- Telegram Bot Setup — Configure real-time order alerts, P&L reports, and secure chat commands.
- Email Signal Routing — Configure email parsing services to convert raw inbox alerts into edge trade executions.
5. Reference Material
Deep specifications, schema registries, and command-line manual trees:
- CLI Commands Index — Complete options, positional arguments, and JSON flag trees for the
hooxtool. - API Spec & REST Routes — HTTP endpoints, request payloads, response templates, and edge errors list.
- Configuration Properties — Comprehensive dictionary of all 31 env keys and 16 KV key-value items.
Offline Reference & AI Context
Consolidated specifications and LLM context packages are available in the GitHub repository.
Tip
Looking for deep engineering plans, DDL SQL schemas, or CI/CD deployment workflows? Check out the DevOps & Architecture Manual for developer-centric operator blueprints!