Files
my-NexusTradingForexBot/docs/getting-started/installation.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

3.6 KiB

title, description, lang
title description lang
Installation Installing Nexus Scalp Engine — packaged release, source bootstrap installer, or developer from-source setup. en

Installation

Three supported paths. Pick one — they do not mix.

Path 1 — End users: packaged Windows release (no Python)

Download NexusScalpEngine-<version>-win-x64-setup.exe (or the portable ZIP NexusScalpEngine-<version>-win-x64.zip) from GitHub Releases. The installer bundles the full Python runtime (PyInstaller) — you never touch Python, pip or PyTorch.

  1. Run the installer (per-user, no admin) or unpack the portable ZIP.
  2. First run opens the setup wizard (nexus setup): compatibility report → mode (default: PAPER, never silently LIVE) → symbol → health check.
  3. User data (config/logs/databases/models) lives in %LOCALAPPDATA%\NexusScalpEngine and survives upgrades, repairs and uninstalls.

Note

Release pipeline: .github/workflows/release.yml builds packaged Windows x64 binaries with SHA-256 digests, release manifests and SBOMs. Details: docs/RELEASE.md.

Path 2 — PowerShell bootstrap installer (no Python, no Git, no admin)

Downloads and provisions everything user-scoped (Python via uv, Git if missing, engine source from GitHub, a managed venv, dependencies, the nexus command on PATH) with safe-update, repair, recovery and a machine-readable stage protocol:

iex (irm https://raw.githubusercontent.com/Opselon/NexusTradingForexBot/main/installer/install.ps1)

The installer enforces download→install integrity at every step: artifacts are verified (size floor, optional SHA256 pin) before being committed, partial downloads are never installed, verification failures BLOCK the install with a precise reason, and every download's digest + outcome is recorded in state\install.json. The full truth table (AVAILABLE / DEGRADED / BLOCKED) is documented in docs/INSTALL_INTEGRITY.md.

.\install.ps1 -DryRun      # show the plan as JSON, mutate nothing
.\install.ps1 -Manifest    # list the installer's 12 stages (JSON)
.\install.ps1 -Repair      # repair runtime without touching user data
.\install.ps1 -Commit sha  # reproducible pin (Commit > Tag > Branch)

Installs under %LOCALAPPDATA%\Nexus (override with -NexusHome); user config in %LOCALAPPDATA%\Nexus\config always survives reinstall/updates. Full parameter reference: docs/INSTALL_WINDOWS.md · architecture: docs/INSTALLER_ARCHITECTURE.md.

Path 3 — Developers: from source

git clone https://github.com/Opselon/NexusTradingForexBot.git
cd NexusTradingForexBot
python -m venv .venv
# Windows PowerShell:
.\.venv\Scripts\Activate.ps1
# Linux/macOS:
source .venv/bin/activate

pip install --upgrade pip
pip install -e .[dev]

# Smoke-test the whole toolchain — no broker needed
pytest tests/unit -q
  • Python 3.11.x is required for a source run (not needed for the packaged release).
  • Windows 10/11 x64 for the native MT5 adapter. ARM64 is explicitly unsupported (PyTorch/Polars/MetaTrader5 ship no ARM64 wheels); nexus doctor reports this.
  • Linux x64 is developer/Docker (remote-gateway adapter) only.

Next step

→ Quickstart