3grander/4depcheck

4depcheck Docker镜像文档

镜像概述

4depcheck（For Dependency Check）是一个基于Docker的依赖检查工具，源自https://github.com/eliasgranderubio/4depcheck%E3%80%82%E8%AF%A5%E9%95%9C%E5%83%8F%E6%8F%90%E4%BE%9B%E4%BA%86%E4%BE%BF%E6%8D%B7%E7%9A%84%E5%AE%B9%E5%99%A8%E5%8C%96%E8%BF%90%E8%A1%8C%E6%96%B9%E5%BC%8F%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%88%86%E6%9E%90%E6%8C%87%E5%AE%9A%E9%A1%B9%E7%9B%AE%E7%9A%84%E4%BE%9D%E8%B5%96%E6%83%85%E5%86%B5%EF%BC%8C%E5%B9%B6%E7%94%9F%E6%88%90%E7%BB%93%E6%9E%84%E5%8C%96%E6%8A%A5%E5%91%8A%E3%80%82

核心功能与特性

• 依赖分析：对指定项目进行依赖检查，识别项目中的依赖组件
• 灵活配置：通过环境变量设置项目名称和路径，简化参数传递
• 结果输出：分析结果同时输出到标准输出（stdout）和JSON文件
• 容器化运行：无需本地安装依赖，直接通过Docker容器运行，环境一致性高

使用场景

• 开发人员在项目构建前检查依赖状况
• 安全团队对项目依赖进行合规性或安全性审计
• CI/CD流程中集成依赖检查步骤，确保代码质量

使用方法

环境变量配置

使用前可通过以下环境变量进行配置（可选）：

• PROJECT_NAME：待分析的项目名称
• ABS_PATH_TO_YOUR_PRJCT：项目在本地的绝对路径

配置示例：

bash
export PROJECT_NAME='project_to_analyze'
export ABS_PATH_TO_YOUR_PRJCT='/home/user/project_to_analyze'

Docker运行命令

已配置环境变量的情况

bash
docker run -v /tmp/4depcheck:/tmp/4depcheck \
           -v $ABS_PATH_TO_YOUR_PRJCT:$ABS_PATH_TO_YOUR_PRJCT \
           docker.xuanyuan.run/3grander/4depcheck:0.1.0 $PROJECT_NAME $ABS_PATH_TO_YOUR_PRJCT

未配置环境变量的情况

直接在命令中替换相应参数：

bash
docker run -v /tmp/4depcheck:/tmp/4depcheck \
           -v /home/user/your_project:/home/user/your_project \
           docker.xuanyuan.run/3grander/4depcheck:0.1.0 your_project_name /home/user/your_project

命令参数说明

• -v /tmp/4depcheck:/tmp/4depcheck：挂载容器内的报告存储目录到本地，用于持久化JSON报告
• -v $ABS_PATH_TO_YOUR_PRJCT:$ABS_PATH_TO_YOUR_PRJCT：挂载本地项目目录到容器，确保工具可访问项目文件
• 3grander/4depcheck:0.1.0：镜像名称及版本
• 最后两个参数：项目名称和项目绝对路径（按顺序传递）

输出说明

• 标准输出（stdout）：实时显示依赖分析过程和结果
• JSON报告：分析结果将保存至 /tmp/4depcheck/$PROJECT_NAME.json（本地路径对应 /tmp/4depcheck/$PROJECT_NAME.json），包含结构化的依赖信息