koalaman/shellcheck-alpine

镜像概述和主要用途

koalaman/shellcheck-alpine是基于Alpine Linux的***Docker镜像，包含ShellCheck——一款针对shell脚本的静态分析工具。该镜像旨在提供轻量级环境，用于检测shell脚本中的语法错误、常见陷阱、可移植性问题和最佳实践违规。如需更小、不含shell及其他工具的镜像，可参考koalaman/shellcheck。

核心功能和特性

• 轻量级基础：基于Alpine Linux构建，镜像体积小，资源占用低
• 静态分析能力：集成ShellCheck工具，支持检测bash、sh、ksh等多种shell脚本的问题
• 灵活集成：可作为基础镜像构建自定义环境，或复制静态链接的二进制文件到任意镜像
• CI友好：适合集成到持续集成/持续部署(CI/CD)流程，实现自动化脚本质量检查
• 版本支持：提供latest(最新Git提交)和stable(稳定版本)等标签

使用场景和适用范围

• 开发环境中通过命令行快速检查本地shell脚本
• 作为Dockerfile基础镜像，构建包含ShellCheck的开发或构建环境
• 集成到CI/CD管道(如GitHub Actions、GitLab CI、Jenkins等)，在代码提交或构建阶段自动检查脚本质量
• 对资源敏感的环境，需要轻量级工具链进行脚本验证

使用方法和配置说明

从命令行运行

通过以下命令可直接在终端使用ShellCheck检查脚本：

查看版本信息

$ docker run --rm -it -v "$(pwd):/mnt" koalaman/shellcheck-alpine:latest shellcheck --version
ShellCheck - shell script analysis tool
version: v0.10.0-62-g3c75d82
license: GNU General Public License, version 3
website: [***]

检查本地脚本

将当前目录挂载到容器的/mnt目录，检查指定脚本：

# 检查当前目录下的script.sh
docker run --rm -it -v "$(pwd):/mnt" koalaman/shellcheck-alpine:stable shellcheck /mnt/script.sh

作为基础镜像

可基于此镜像构建自定义Docker环境：

创建包含ShellCheck的自定义镜像

FROM koalaman/shellcheck-alpine:stable
MAINTAINER Your Name <***>
# 添加自定义工具或配置
RUN apk add --no-cache bash
CMD ["bash"]

复制二进制文件到其他镜像

将静态链接的ShellCheck二进制文件复制到任意镜像(如基础Alpine镜像)：

FROM alpine:latest
# 从stable标签镜像复制shellcheck二进制文件
COPY --from=koalaman/shellcheck:stable /bin/shellcheck /bin/
# 验证安装
RUN shellcheck --version

集成到CI工作流

如需将ShellCheck集成到CI流程，可参考koalaman/shellcheck的详细指南。

注意：shellcheck-alpine使用sh作为entrypoint，因此在执行命令时需显式指定shellcheck。以下命令功能等效：

# 使用标准镜像(无shell entrypoint)
docker run --rm -it koalaman/shellcheck:stable --version

# 使用alpine镜像(需显式指定shellcheck)
docker run --rm -it koalaman/shellcheck-alpine:stable shellcheck --version