Files
my-NexusTradingForexBot/docs/reference/cli-reference.md
T
gavindiazandClaude Code 3a005ddcc6
Docs / Validate documentation (push) Canceled after 0s
Docs / Deploy GitHub Pages (push) Canceled after 0s
CI Final Summary (AI) / AI Final Summary (push) Canceled after 0s
CI Final Summary (AI) / Push/PR event feed (push) Canceled after 0s
CI / CI Integrity and Change Classification (push) Canceled after 0s
CI / Code Quality & Tests (push) Canceled after 0s
Dependency Lock & Migration Safety / Dependency drift (lock vs pyproject) (push) Canceled after 0s
Dependency Lock & Migration Safety / Migration safety (fail-loud + version postconditions) (push) Canceled after 0s
JS Tests / Frontend JS Unit Tests (push) Canceled after 0s
Security / CodeQL Analysis (push) Canceled after 0s
Security / Trivy Vulnerability Scan (push) Canceled after 0s
Tests (OS Matrix) / Py Tests (macos-latest) (push) Canceled after 0s
Tests (OS Matrix) / Py Tests (windows-latest) (push) Canceled after 0s
CI / Extended Validation (Tier 2) (push) Canceled after 0s
CI / Heavy CI (database-provider) (push) Canceled after 0s
CI / Heavy CI (e2e) (push) Canceled after 0s
CI / Heavy CI (integration) (push) Canceled after 0s
CI / Heavy CI (model-validation) (push) Canceled after 0s
CI / Heavy CI (research-backtest) (push) Canceled after 0s
CI / Aggregate CI Results (push) Canceled after 0s
chore(repo): initial import of Nexus Trading Forex Bot into self-hosted hosting
Full project import for the self-hosted code hosting
(https://code.aifunny.ltd/gavindiaz/my-NexusTradingForexBot.git).

Includes the live-freshness + scaler-hash fixes for the permanent
STALE dashboard (tick_pipeline now_utc stamps; infer_probabilities
computes model_input_hash on the actual scaled 70D tensor), the
data-fetch default-path fix, the g29 web-auth test fixes, and a
Chinese user manual (使用手册.md) for the web dashboard.

Scratch diagnostic scripts (check*.py, contain a live web-auth token)
and the .kilo/ agent-worktree directory are gitignored, not committed.

Co-Authored-By: Claude Code <noreply@anthropic.com>
2026-09-23 23:24:54 +08:00

2.8 KiB

title, description, lang
title description lang
CLI Reference Machine-oriented reference of the nexus CLI surface — commands, flags, exit codes. en

CLI Reference

The authoritative surface is always nexus help / nexus <command> --help (this page documents the verified contract; the CLI is golden-tested by 66 end-to-end tests).

Global flags

Flag Effect
--json machine-readable output (parity-tested keys)
--plain no color, no formatting
--no-color disable color only

Command groups

Command Purpose Notes
nexus start [--mode paper|shadow|live] [--port N] [--daemon] run engine paper default; live needs interactive --yes/confirmation; port default 8080
nexus stop / nexus restart daemon control pidfile-based; dead-pid reported honestly (BUG-172)
nexus doctor 19-category diagnostics + suggested fixes --json for tooling
nexus status / nexus health environment + health READY / DEGRADED / NOT READY
nexus config [--validate path] [--show] configuration inspection secrets masked
nexus logs [--tail N] [--errors] log access severity-split store
nexus test --mode quick|unit|integration run suites never runs live-broker tests
nexus update <sub> update lifecycle check|latest|download|install|verify|status|history|rollback|doctor
nexus release info installed release metadata release identity lock
nexus repair non-destructive derived-state repair never deletes user data
nexus db <sub> migrate, hygiene status|plan|run|pause|resume|history hygiene AUDIT_ONLY default
nexus incidents <sub> incident center list / reports / export (sanitized)
nexus forensic [---deploy-gate] forensic health engine deploy gate wired into beforePush
nexus model-dataset-build build canonical dataset fingerprinted, immutable
nexus model-experiment-create create experiment fair A/B/C protocol
nexus model-train train candidate deterministic seeds
nexus model-validate validate candidate walk-forward + OOS + robustness
nexus model-replay replay parity bit-exact proof
nexus setup / nexus install first-run wizard compat → mode → symbol → health
nexus export-diagnostics sanitized diagnostics ZIP never contains secrets
nexus uninstall [--no-keep-data] remove installation user data preserved by default

Exit codes

0 success · 1 runtime/validation failure · 2 invalid usage · 3 environment blocked · 4 release verification failure · 5 update not applicable/failed.

Legacy entrypoints

python NexusTradingForexBot.py --doctor | --config configs/live.yaml | --symbol EURUSD | --gateway — the legacy launcher (still supported; main.py redirects). Prefer the nexus surface.