apunkt/nyx

mirror of https://github.com/elicpeter/nyx.git synced 2026-06-06 19:35:13 +02:00

* chore: Exclude CLAUDE.md from Cargo.toml

* feat: add callgraph module and integrate into main analysis flow

* feat: enhance CLI with new severity filtering and analysis modes

* feat: update CHANGELOG with recent enhancements and fixes to severity filtering and output handling

* feat: implement state-model dataflow analysis for resource lifecycle and auth state

* feat: enhance diagnostic output formatting and add evidence structure

* feat: implement attack surface ranking for diagnostics with scoring and sorting

* feat: add comprehensive documentation for installation, usage, and rules reference

* feat: add multiple language support for command execution and evaluation endpoints

* feat: implement inline suppression for findings using `nyx:ignore` comments

* feat: add confidence levels to AST patterns and update output structure

* feat: implement low-noise prioritization system with category filtering, rollup grouping, and configurable budgets

* feat: bump version to 0.4.0 and update changelog with new features and improvements

* feat: add dead code allowances to various functions in mod.rs and real_world_tests.rs

2026-02-25 21:16:36 -05:00

1.6 KiB

Raw Blame History

Installation

Install from crates.io

cargo install nyx-scanner

This installs the nyx binary into ~/.cargo/bin/.

Install from GitHub releases

Go to the Releases page.

Download the binary for your platform:

Platform	Archive
Linux x86_64	`nyx-x86_64-unknown-linux-gnu.zip`
macOS Intel	`nyx-x86_64-apple-darwin.zip`
macOS Apple Silicon	`nyx-aarch64-apple-darwin.zip`
Windows x86_64	`nyx-x86_64-pc-windows-msvc.zip`

Extract and install:

# Linux / macOS
unzip nyx-*.zip
chmod +x nyx
sudo mv nyx /usr/local/bin/

# Windows (PowerShell)
Expand-Archive -Path nyx-*.zip -DestinationPath .
Move-Item -Path .\nyx.exe -Destination "C:\Program Files\Nyx\"

Verify:
```
nyx --version
```

Build from source

git clone https://github.com/elicpeter/nyx.git
cd nyx
cargo build --release
cargo install --path .

Requires Rust 1.85+ (edition 2024).

CI Integration

GitHub Actions

- name: Install Nyx
  run: cargo install nyx-scanner

- name: Run security scan
  run: nyx scan . --format sarif --fail-on medium > results.sarif

- name: Upload SARIF
  uses: github/codeql-action/upload-sarif@v3
  with:
    sarif_file: results.sarif

Generic CI

# Fail the build if any High or Medium finding is detected
nyx scan . --severity ">=MEDIUM" --fail-on medium --quiet --format json

The --fail-on flag causes Nyx to exit with code 1 if any finding meets or exceeds the given severity. Exit code 0 means no findings matched.

1.6 KiB Raw Blame History