Hoox Docs

๐Ÿ› ๏ธ CLI Commands Reference

The @jango-blockchained/hoox-cli tool manages the entire monorepo development, provisioning, deployment, monitoring, and self-healing pipelines. This reference provides the complete command tree, positional arguments, optional flags, and concrete examples for all 15 command groups.


๐Ÿ—บ๏ธ Global Flags

These options are registered globally and can be appended to any command:

FlagDescriptionExample
--jsonOutputs machine-parseable JSON format (ideal for script pipelines).hoox monitor status --json
--quietSuppresses headers, banners, and interactive prompts.hoox deploy kv-config --quiet
--helpPrints complete parameter and option listings.hoox infra d1 --help
--versionOutputs active CLI package build version.hoox --version

๐Ÿ—‚๏ธ Command Groups Directory

hoox                                 Launch TUI (when run with no args)
โ”œโ”€โ”€ init                             Interactive multi-phase setup wizard
โ”œโ”€โ”€ clone [name]                     Bootstrap workspace from template
โ”œโ”€โ”€ dev                              Local development execution engine
โ”‚   โ”œโ”€โ”€ start                        Start all workers (native or Docker)
โ”‚   โ”œโ”€โ”€ worker <name>                Start a single worker
โ”‚   โ””โ”€โ”€ dashboard                    Start Next.js dashboard dev server
โ”œโ”€โ”€ deploy                           Edge deployment pipelines
โ”‚   โ”œโ”€โ”€ all                          Roll out all workers + dashboard in sequence
โ”‚   โ”œโ”€โ”€ worker <name>                Deploy a single edge worker
โ”‚   โ”œโ”€โ”€ dashboard                    Deploy Next.js dashboard via OpenNext
โ”‚   โ”œโ”€โ”€ telegram-webhook             Register Telegram bot webhook API
โ”‚   โ”œโ”€โ”€ update-internal-urls         Bind inter-worker Service Binding URLs
โ”‚   โ””โ”€โ”€ kv-config                    Synchronize KV manifest variables
โ”œโ”€โ”€ infra                            Cloudflare resource provisioning IaC
โ”‚   โ”œโ”€โ”€ provision                    Auto-provision all required services
โ”‚   โ”œโ”€โ”€ d1 [list/create/delete]      Manage D1 databases
โ”‚   โ”œโ”€โ”€ kv [list/create/delete]      Manage KV namespaces
โ”‚   โ”œโ”€โ”€ r2 [list/create/delete]      Manage R2 object storage buckets
โ”‚   โ”œโ”€โ”€ queues [list/create/delete]  Manage Cloudflare Queues
โ”‚   โ””โ”€โ”€ vectorize [create/delete]    Manage vector search indexes
โ”œโ”€โ”€ config                           Workspace and environmental variables
โ”‚   โ”œโ”€โ”€ env [init/show/validate]     Manage .env.local build variables
โ”‚   โ”œโ”€โ”€ kv [set/get/list/delete]     Get/Set dynamic KV runtime parameters
โ”‚   โ””โ”€โ”€ show/set                     View or set wrangler.jsonc values
โ”œโ”€โ”€ check                            Toolchain and route diagnostic suite
โ”‚   โ”œโ”€โ”€ prerequisites                Validate local machine tool installs
โ”‚   โ”œโ”€โ”€ setup                        Audit .env configurations
โ”‚   โ””โ”€โ”€ health                       Probe worker /health endpoints
โ”œโ”€โ”€ db                               SQLite D1 Database administration
โ”‚   โ”œโ”€โ”€ apply                    Apply DDL schemas to D1
โ”‚   โ”œโ”€โ”€ migrate                  Run schema migrations
โ”‚   โ”œโ”€โ”€ list                     Display active SQLite tables
โ”‚   โ”œโ”€โ”€ query <sql>              Execute custom SQL reads
โ”‚   โ”œโ”€โ”€ export                   Dump database as a secure SQL file
โ”‚   โ””โ”€โ”€ reset                    Destructive truncate of all tables
โ”œโ”€โ”€ monitor                          Observability and emergency controls
โ”‚   โ”œโ”€โ”€ status                       Probe active worker health routes
โ”‚   โ”œโ”€โ”€ trades [N]                   Aggregate recent filled transactions
โ”‚   โ”œโ”€โ”€ logs [worker]                Tail and inspect time-series logs
โ”‚   โ”œโ”€โ”€ queue-depth                  Audit message counts in queues
โ”‚   โ”œโ”€โ”€ backup                       Backup SQL ledger to backups/
โ”‚   โ””โ”€โ”€ kill-switch [show/on/off]    Emergency global trading halt
โ”œโ”€โ”€ repair                           System diagnostics & self-healing
โ”‚   โ”œโ”€โ”€ check                        Run 5-step checklist
โ”‚   โ”œโ”€โ”€ worker <name>                Rebuild a degraded worker
โ”‚   โ”œโ”€โ”€ infra                        Verify and repair missing edge bindings
โ”‚   โ”œโ”€โ”€ secrets                      Re-sync hardware secrets
โ”‚   โ”œโ”€โ”€ kv                           Restore KV manifest defaults
โ”‚   โ”œโ”€โ”€ db                           Re-apply Drizzle migrations
โ”‚   โ””โ”€โ”€ rebuild                      Full destructive interactive rebuild
โ”œโ”€โ”€ logs                             Time-series log extraction
โ”‚   โ”œโ”€โ”€ tail <worker>                Stream live edge logging console
โ”‚   โ””โ”€โ”€ download <worker>            Download logs to a local file
โ”œโ”€โ”€ test                             Run verification pipeline (CI)
โ””โ”€โ”€ waf                              Auto-configure Cloudflare WAF firewall rules

๐Ÿš€ Key Commands Detail & Examples

A. Initialization & Bootstrap

# Onboard a new machine, configure accounts and select worker profile
hoox init

# Verify that git, bun, wrangler, and docker are correctly configured
hoox check prerequisites

B. Local Development

# Start all workers in a Docker container stack
hoox dev start --runtime docker

# Start only the Next.js frontend developer server
hoox dev dashboard

C. Edge Provisioning & Deployment

# Provision all databases, buckets, and queues on your Cloudflare account
hoox infra provision

# Deploy the entire microservices stack in sequence, automatically updating URLs
hoox deploy all --auto

D. Operational Monitoring & Emergency halting

# Emergency Halt: halt all trade signals globally in under 10 seconds
hoox config kv set trade:kill_switch true

# Audit active trade history table
hoox monitor trades 25

E. Database Administration

# Query the total sum of fees paid today across Bybit
hoox db query "SELECT SUM(fee) FROM trades WHERE created_at >= date('now')" --remote

F. Self-Healing & Diagnostics

# Run a full workspace system audit
hoox repair check

Tip: Every single subcommand is fully documented locally! Append --help to any command (e.g. hoox config env --help) to view advanced positional arguments and specific flag options instantly.

๐Ÿ”— Next Steps