Installation

One-Line Install (Recommended)

Linux / macOS

curl -fsSL https://codescan.siiway.org/install.sh | sh

The script auto-detects your OS and CPU architecture, downloads the right pre-compiled binary from the latest GitHub Release, and installs it to /usr/local/bin.

To install a specific version:

CODESCAN_VERSION=v0.2.0 curl -fsSL https://codescan.siiway.org/install.sh | sh

To install to a custom directory:

CODESCAN_INSTALL_DIR=~/.local/bin curl -fsSL https://codescan.siiway.org/install.sh | sh

Windows (PowerShell)

iwr https://codescan.siiway.org/install.ps1 | iex

The script installs to %LOCALAPPDATA%\Programs\codescan and adds it to your user PATH automatically.

To install a specific version:

$env:CODESCAN_VERSION = "v0.2.0"
iwr https://codescan.siiway.org/install.ps1 | iex

Via cargo (crates.io)

If you have Rust installed:

cargo install codescan

Pre-compiled Binaries

Download the latest binary directly from GitHub Releases:

Platform	Architecture	Download
Linux	x86_64	codescan-{version}-x86_64-unknown-linux-musl.tar.gz
Linux	ARM64	codescan-{version}-aarch64-unknown-linux-musl.tar.gz
macOS	Apple Silicon	codescan-{version}-aarch64-apple-darwin.tar.gz
macOS	Intel	codescan-{version}-x86_64-apple-darwin.tar.gz
Windows	x86_64	codescan-{version}-x86_64-pc-windows-msvc.zip
Windows	ARM64	codescan-{version}-aarch64-pc-windows-msvc.zip

A SHA256SUMS.txt file is included in each release for checksum verification.

Build from Source

git clone https://github.com/siiway/codescan
cd codescan
cargo build --release
# binary at: target/release/codescan

Verify Installation

codescan --version

Dependencies

codescan is a single self-contained binary with no runtime dependencies. All Rust crate dependencies are statically linked.

Crate	Purpose
clap	CLI argument parsing
regex	Pattern matching (linear-time, safe)
rayon	Parallel file scanning
ignore	Gitignore-aware directory traversal
serde / serde_json	JSON config and custom rules
toml	TOML configuration file parsing
globset	Glob pattern matching for suppressions
colored	Terminal color output
once_cell	Lazy static regex compilation
tracing	Structured diagnostic logging

See THIRD_PARTY_LICENSES for full license text.