Skip to content

development.md

Latest commit

 

History

History
64 lines (47 loc) · 1.37 KB

development.md

File metadata and controls

64 lines (47 loc) · 1.37 KB

Development

Prerequisites

  • Rust stable toolchain
  • Git
  • Node.js (only if testing npm wrapper flows)
  • MkDocs (for docs preview)

Build And Test

cargo build --workspace --release
cargo test --workspace

Run Locally

# interactive TUI
cargo run -p scanr-cli --

# regular scan
cargo run -p scanr-cli -- scan .

# structured outputs
cargo run -p scanr-cli -- scan . --json
cargo run -p scanr-cli -- scan . --sarif

# SBOM operations
cargo run -p scanr-cli -- sbom generate
cargo run -p scanr-cli -- sbom diff old.cdx.json new.cdx.json

Workspace Layout

crates/scanr-engine   shared engine contracts and finding schema
crates/scanr-sca      SCA engine implementation and models
crates/scanr-cli      command and TUI frontend
installers/           packaging assets (npm, bun, brew, aur, curl)
docs/                 mkdocs source pages

CI And Release Workflows

  • .github/workflows/ci.yml
    • Builds workspace on push and pull request
  • .github/workflows/release.yml
    • Builds release binaries for Linux/macOS/Windows
    • Publishes release assets for tag builds

Package Distribution Files

  • npm wrapper: installers/npm
  • Homebrew formula: installers/homebrew/scanr.rb
  • AUR package files: installers/aur/PKGBUILD, installers/aur/.SRCINFO
  • curl bootstrap installer: installers/install.sh

Docs Preview

mkdocs serve