mirror of
https://github.com/elicpeter/nyx.git
synced 2026-06-06 19:35:13 +02:00
1bbe4b1cfb
* 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
1.5 KiB
1.5 KiB
Nyx Documentation
Welcome to the Nyx documentation. Nyx is a multi-language static vulnerability scanner built in Rust.
User Guide
- Installation — Install via cargo, prebuilt binaries, or from source
- Quick Start — Your first scan in 60 seconds
- CLI Reference — Every flag, subcommand, and option
- Configuration — Config file schema, precedence, custom rules
- Output Formats — Console, JSON, SARIF; exit codes; evidence fields
Detector Reference
- Detector Overview — How the four detector families work together
- Taint Analysis — Cross-file source-to-sink dataflow tracking
- CFG Structural Analysis — Auth gaps, unguarded sinks, resource leaks
- State Model Analysis — Resource lifecycle and authentication state
- AST Patterns — Tree-sitter structural pattern matching
Rule Reference
- Rule Index — How rules are organized
- Rust | C | C++ | Java | Go
- JavaScript | TypeScript | Python
- PHP | Ruby
Contributing
- Contributing Guide — Development setup, adding rules, PR guidelines
- Security Policy — Responsible disclosure
- Code of Conduct