NEXUS
Documentation menu

Docs · Getting Started

Installation

The Fleet installs with a single command and runs anywhere Python 3.8+ is available. The desktop app is built from source with the Tauri toolchain.

GUI, CLI, or both?. Desktop (GUI) — install the app, redeem your Pro code in Settings → License. CLI / Fleet — pip install nexus-fleet and apply your token viaNEXUS_LICENSE. Both on one machine — install each; redeem the Pro code once in the GUI and the CLI reuses the same device-bound license automatically (no second code).

Nexus Fleet (CLI)

Pick either package manager — both install the umbrella nexus command + five twins.

With pip (recommended)

bash
pip install nexus-fleet
nexus --version          # nexus 2.2.1

With npm

The npm package is a thin Node wrapper around the Python engine; it still requires Python on the host.

bash
npm install -g nexus-fleet

Either way you get the umbrella command nexus plus:

  • nexus-manager — the central API server + web dashboard
  • nexus-agent — the endpoint daemon
  • nexus-cli — the interactive SOC console
  • nexus-dashboard — standalone dashboard server
  • nexus-license — license generation & inspection
Requirement. The agent is stdlib-only, so the only prerequisite is Python 3.8+ — no cluster, indexer, or heavy runtime to manage.

Nexus Desktop (GUI)

Install the released app (recommended)

Download and run the installer — it bundles the Python engine and runtime, so end users need nothing else. On first launch the Setup Wizard handles the ethical-use agreement and optional one-click tool installation.

text
Nexus_2.2.1_x64-setup.exe   # Windows x64 installer (NSIS)

Build from source

The GUI is a Tauri 2 application. Building it from source needs Node, Rust and Python installed.

bash
git clone https://github.com/chandafa/cyber-nexus-.git nexus
cd nexus
npm install
npm run tauri:dev     # development with hot reload
npm run tauri:build   # production installer (.exe / .msi / .dmg / .AppImage)

Toolchain

  • Windows — Visual Studio C++ Build Tools + WebView2
  • macOS — xcode-select --install
  • Linux — libwebkit2gtk-4.1-dev build-essential libssl-dev libgtk-3-dev librsvg2-dev
First build is slow. The first desktop build compiles Rust + SQLite from source (~5–15 min). Subsequent builds are incremental.

After installing — what next?

If you installed the CLI (Fleet)

  • Verify it: nexus --version (prints nexus 2.2.1).
  • Start a manager, then enroll agents — see Fleet.
  • Apply a Pro token with export NEXUS_LICENSE=<token-or-file> or nexus cli apply-license.

If you installed the Desktop app (GUI)

  • Launch it; the Setup Wizard handles the ethical-use agreement and tool detection.
  • Redeem your Pro code in Settings → License — it binds to this device.
  • Free modules work immediately; Pro modules unlock once the license is valid.

I already have one — can I add the other?

Yes. Install the second one normally. You do not need a second license code. Redeem your Pro code once (in the GUI or via the CLI) and it is stored device-bound at~/.nexus/desktop_license.txt — the desktop app, the CLI, and Fleet all read the same token automatically. One device, one code, everything unlocked.

PreviousIntroductionNext Ecosystem & Architecture