shellcheck

环境要求

• 一台可联网的机器，按系统选择对应包管理器（apt/pacman/dnf/brew/choco 等）
• 如需从源码编译：Haskell 工具链 Cabal 或 Stack
• 如使用 Linux 预编译包：需安装 xz（Debian 系 apt install xz-utils，RedHat 系 yum -y install xz）
• 如不想本地安装：可用 Docker（镜像 koalaman/shellcheck:stable）

安装与启动步骤

1. 1用包管理器安装

   按自己的系统选择对应的一条命令执行，这是 README 推荐的最简单本地安装方式

   sudo apt install shellcheck
   pacman -S shellcheck
   emerge --ask shellcheck
   dnf install ShellCheck
   brew install shellcheck
   choco install shellcheck
   winget install --id koalaman.shellcheck
   scoop install shellcheck
   conda install -c conda-forge shellcheck
   snap install --channel=edge shellcheck

   复制

2. 2Docker 免安装运行

   无需本地安装，把脚本所在目录挂载到容器 /mnt，myscript 换成你的脚本文件名

   docker run --rm -v "$PWD:/mnt" koalaman/shellcheck:stable myscript

   复制

3. 3安装预编译二进制

   Linux 上可下载官方 tar.xz 包，解压后把 shellcheck 复制到 /usr/bin，scversion 可改为 v0.4.7 或 latest

   scversion="stable"
   wget -qO- "https://github.com/koalaman/shellcheck/releases/download/${scversion?}/shellcheck-${scversion?}.linux.x86_64.tar.xz" | tar -xJv
   cp "shellcheck-${scversion}/shellcheck" /usr/bin/
   shellcheck --version

   复制

4. 4从源码编译安装

   需要先装好 Cabal 或 Stack；Cabal 装到 ~/.cabal/bin，Stack 装到 ~/.local/bin

   cabal update
   cabal install ShellCheck

   复制

5. 5验证安装并检查脚本

   用 --version 确认安装成功，再对目标脚本运行 shellcheck 查看告警与改进建议

   shellcheck --version
   shellcheck yourscript.sh

   复制

6. 6接入编辑器或 CI

   README 提到可在编辑器内和构建/测试套件中使用 ShellCheck，具体插件与流水线配置请参考对应工具的文档

关键配置

如何确认成功

执行 shellcheck --version，能正常输出版本信息即安装成功；再对脚本运行 shellcheck yourscript.sh 可看到检查结果

常见问题

注意事项

• Docker 运行时脚本必须位于当前目录，因为 $PWD 被挂载到容器的 /mnt。
• 预编译二进制以 tar.xz 形式发布，解压前请确保系统已安装 xz。
• Cabal 与 Stack 的安装目录不同，安装后可能需要手动配置 PATH。
• README 未给出编辑器插件和 CI 的具体配置命令，需自行查阅对应工具文档。