koalaman/shellcheck-alpine

koalaman/shellcheck-alpine

镜像概述和主要用途

koalaman/shellcheck-alpine是基于Alpine Linux的官方Docker镜像，包含https://github.com/koalaman/shellcheck%E2%80%94%E2%80%94%E4%B8%80%E6%AC%BE%E9%92%88%E5%AF%B9shell%E8%84%9A%E6%9C%AC%E7%9A%84%E9%9D%99%E6%80%81%E5%88%86%E6%9E%90%E5%B7%A5%E5%85%B7%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%97%A8%E5%9C%A8%E6%8F%90%E4%BE%9B%E8%BD%BB%E9%87%8F%E7%BA%A7%E7%8E%AF%E5%A2%83%EF%BC%8C%E7%94%A8%E4%BA%8E%E6%A3%80%E6%B5%8Bshell%E8%84%9A%E6%9C%AC%E4%B8%AD%E7%9A%84%E8%AF%AD%E6%B3%95%E9%94%99%E8%AF%AF%E3%80%81%E5%B8%B8%E8%A7%81%E9%99%B7%E9%98%B1%E3%80%81%E5%8F%AF%E7%A7%BB%E6%A4%8D%E6%80%A7%E9%97%AE%E9%A2%98%E5%92%8C%E6%9C%80%E4%BD%B3%E5%AE%9E%E8%B7%B5%E8%BF%9D%E8%A7%84%E3%80%82%E5%A6%82%E9%9C%80%E6%9B%B4%E5%B0%8F%E3%80%81%E4%B8%8D%E5%90%ABshell%E5%8F%8A%E5%85%B6%E4%BB%96%E5%B7%A5%E5%85%B7%E7%9A%84%E9%95%9C%E5%83%8F%EF%BC%8C%E5%8F%AF%E5%8F%82%E8%80%83https://hub.docker.com/repository/docker/koalaman/shellcheck%E3%80%82

核心功能和特性

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

使用场景和适用范围

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

使用方法和配置说明

从命令行运行

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

查看版本信息

bash
$ 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: https://www.shellcheck.net

检查本地脚本

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

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

作为基础镜像

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

创建包含ShellCheck的自定义镜像

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

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

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

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

集成到CI工作流

如需将ShellCheck集成到CI流程，可参考https://hub.docker.com/repository/docker/koalaman/shellcheck%E7%9A%84%E8%AF%A6%E7%BB%86%E6%8C%87%E5%8D%97%E3%80%82

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

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

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