INIT / Install

[GET HOOX RUNNING]

Source, package managers, Docker, or Cloudflare — pick a path. Operate with CLI, TUI, or dashboard.

← BACK TO HOMEClone on GitHubDeploy to Cloudflare ↗
Fastest path
git clone --recursive …→bun install→hoox onboard→hoox deploy all --auto
[ source ]01Full Stack★ recommended

From Source

Clone the monorepo with all 9 worker submodules, install workspace dependencies, and run the one-shot onboard wizard. This is the canonical path for contributors and operators who need the full worker mesh.

  • ▸Workers are Git submodules — without --recursive they will be empty directories.
  • ▸If you already cloned, run: git submodule update --init --recursive
GitHub Repository ↗5-Minute Quick Start ↗
[ package ]02CLI Only★ recommended

Via Bun (Global CLI)

Install @jango-blockchained/hoox-cli globally with Bun. Requires Bun ≥ 1.2 — the CLI is a Bun bundle and will not run under Node.js even if installed via npm.

  • ▸Global install gives you the hoox command; you still need a cloned workspace for deploy and dev.
  • ▸Run hoox update to self-update the CLI and check wrangler versions.
npm package ↗
[ package ]03Requires Bun

Via npm

The CLI is published to npm as @jango-blockchained/hoox-cli, but npm install -g alone will not produce a working binary. You must have Bun installed — the shebang and bundle target are Bun-only.

Alternativenpm install -g @jango-blockchained/hoox-cli
  • ▸npm install -g downloads the package but hoox will not execute under Node.js.
  • ▸Use bun add -g for the supported global install path.
[ docker ]04Compose Profiles

Docker — Local Dev

Run the full worker mesh and dashboard locally via Docker Compose. Mirrors production service-binding topology — only hoox (gateway) and dashboard expose host ports.

Gateway# http://localhost:8787
Dashboard# http://localhost:8794
  • ▸Profiles: workers, dashboard, full (workers + dashboard).
  • ▸Requires .env.local for exchange keys and Telegram token (optional on fresh clone).
  • ▸Equivalent native path: hoox dev start --runtime native
[ docker ]05Air-Gapped

Docker — Production / Self-Hosted

Build the production image (Dockerfile.prod) for demos, local testing, or air-gapped deployments. Not a full substitute for Cloudflare edge — Durable Objects, Vectorize, and Workers AI are unavailable.

  • ▸Self-hosted gateway requires HOOX_SERVER_API_KEY for authenticated requests.
  • ▸Cloudflare-specific features (DO idempotency, Vectorize RAG, Browser Rendering) are not supported self-hosted.
  • ▸Production recommendation: hoox deploy all --auto on Cloudflare Workers.
[ cloudflare ]06Production★ recommended

Deploy to Cloudflare

Deploy all 10 workers and the OpenNext dashboard to Cloudflare's edge. The onboard wizard provisions D1, KV, secrets, and deploys in the correct dependency order.

  • ▸Dashboard deploys to Cloudflare Workers via OpenNext — not Cloudflare Pages.
  • ▸Pass credentials non-interactively: hoox onboard --token cfut_xxx --account xxx --preset full
Installation Guide ↗Deploy Workers Guide ↗Cloudflare Dashboard ↗
[ source ]07Fine Control

Init & Setup (Step-by-Step)

Split onboarding into init (writes wrangler.jsonc, collects secrets) and setup (generates keys, applies D1 schema, pushes secrets, deploys dashboard). Use when you need granular control over provisioning.

  • ▸hoox init --self-hosted configures a VPS deployment without Cloudflare dependency.
  • ▸Resume interrupted wizard: hoox onboard --resume
Interfaces

[CLI · TUI · DASHBOARD]

CLI for automation, TUI for ops, dashboard for monitoring.

CLI

Full ref →

28 command groups · 100+ subcommands

The primary operator interface. Manages workers, infrastructure, secrets, deployments, health checks, monitoring, repair, and performance measurement. Running hoox with no arguments launches the TUI.

Recommended entry point

Workers + dashboard + wiring

Interactive native vs Docker

Post-deploy verification

Live trade stream

Latency probes

Workers Observability

Diagnose & fix

TUI

OpenTUI terminal dashboard

Full-screen terminal operations center. Monitor workers, trades, logs, and deployments without leaving the shell. Launch via hoox tui or bun run from packages/tui.

From any workspace

Hot reload

Standalone

Repo root script

Keyboard shortcuts
Ctrl+1Dashboard view
Ctrl+2Workers overview
Ctrl+4Trade monitor
Ctrl+5Logs viewer
Ctrl+6Service manager (deploy/restart)
Ctrl+8Setup wizard
Ctrl+PCommand palette
Ctrl+QQuit

Dashboard

Next.js 16 · OpenNext on Workers

Web command center for portfolio monitoring, risk management, and emergency actions. Reads from D1, writes to CONFIG_KV, dispatches through the hoox gateway. Protected by Cloudflare Access in production.

localhost:3000

Same as above

Build + deploy to Workers

Same as above

localhost:8794

  • ▸Production URL: https://<your-subdomain>.workers.dev (set during onboard)
  • ▸Requires hoox, d1-worker, and agent-worker running for full functionality
Install paths7
Workers10
CLI version0.9.3
hoox onboard → hoox deploy all --auto → live on edge