Skip to content

安装

一键安装(推荐)

Linux / macOS

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

脚本会自动检测你的操作系统和 CPU 架构,从最新 GitHub Release 下载对应的预编译二进制文件,并安装到 /usr/local/bin

安装指定版本:

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

安装到自定义目录:

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

Windows(PowerShell)

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

脚本会安装到 %LOCALAPPDATA%\Programs\codescan 并自动将其添加到用户 PATH。

安装指定版本:

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

通过 cargo 安装(crates.io)

如果你已安装 Rust

bash
cargo install codescan

预编译二进制文件

GitHub Releases 直接下载最新二进制文件:

平台架构文件名
Linuxx86_64codescan-{version}-x86_64-unknown-linux-musl.tar.gz
LinuxARM64codescan-{version}-aarch64-unknown-linux-musl.tar.gz
macOSApple Siliconcodescan-{version}-aarch64-apple-darwin.tar.gz
macOSIntelcodescan-{version}-x86_64-apple-darwin.tar.gz
Windowsx86_64codescan-{version}-x86_64-pc-windows-msvc.zip
WindowsARM64codescan-{version}-aarch64-pc-windows-msvc.zip

每个 Release 均包含 SHA256SUMS.txt 文件用于校验。

从源码构建

bash
git clone https://github.com/siiway/codescan
cd codescan
cargo build --release
# 二进制文件位于:target/release/codescan

验证安装

bash
codescan --version

依赖项

codescan 是一个独立的单文件二进制,无运行时依赖。所有 Rust crate 依赖均静态链接。

Crate用途
clapCLI 参数解析
regex模式匹配(线性时间,安全)
rayon并行文件扫描
ignore.gitignore 感知目录遍历
serde / serde_jsonJSON 配置和自定义规则
tomlTOML 配置文件解析
globset抑制规则的 Glob 模式匹配
colored终端彩色输出
once_cell懒加载静态正则编译
tracing结构化诊断日志

完整许可证文本见 THIRD_PARTY_LICENSES