crazymax/linguist

GitHub Linguist 镜像文档

镜像概述

本镜像为基于Alpine Linux的GitHub Linguist工具容器化版本。GitHub Linguist是一款用于检测代码仓库中编程语言构成的工具，可统计不同语言的代码行数、生成语言使用报告，并支持多种输出格式。Alpine Linux基础确保镜像体积小巧、资源占用低，适合快速集成到开发流程或自动化环境中。

核心功能与特性

• 轻量高效：基于Alpine Linux构建，镜像体积小，启动速度快，资源消耗低
• 功能完整：集成GitHub Linguist全部核心功能，支持语言检测、代码统计与分类
• 易用性强：无需本地安装依赖，直接通过容器运行即可分析代码仓库
• 灵活输出：支持多种报告格式（文本、JSON等）及详细程度控制
• 跨平台兼容：可在任何支持Docker的环境中运行，包括Linux、macOS和Windows

使用场景

• 代码仓库语言成分分析与统计
• 生成项目语言构成报告
• 集成到CI/CD流程中，自动化检测代码语言变化
• 开发环境中快速分析本地代码仓库的语言分布
• 教育或研究场景下的多项目语言趋势分析

使用方法

基本使用

通过docker run命令直接运行，分析本地代码仓库：

bash
docker run --rm -v /path/to/local/repo:/repo crazy-max/linguist /repo

参数说明

支持GitHub Linguist原生命令行参数，常用参数包括：

• --breakdown：显示各语言文件级别的详细统计
• --json：输出JSON格式报告
• --no-progress：禁用进度条显示
• --exclude=PATTERN：排除符合指定模式的文件

示例：生成JSON格式的详细统计报告

bash
docker run --rm -v /path/to/repo:/repo crazy-max/linguist /repo --json --breakdown > language-report.json

高级配置

分析远程仓库

可结合Git命令在容器内克隆并分析远程仓库：

bash
docker run --rm crazy-max/linguist sh -c "git clone https://github.com/example/repo.git /tmp/repo && linguist /tmp/repo"

集成到CI/CD流程

在GitHub Actions等CI环境中使用，示例GitHub Actions配置：

yaml
jobs:
  analyze-language:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run Linguist
        run: docker run --rm -v ${{ github.workspace }}:/repo crazy-max/linguist /repo --json > language-report.json
      - name: Upload report
        uses: actions/upload-artifact@v3
        with:
          name: language-report
          path: language-report.json

获取帮助

查看完整命令帮助：

bash
docker run --rm crazy-max/linguist --help

镜像信息

• 基础镜像：Alpine Linux
• 工具版本：同步GitHub Linguist官方最新稳定版
• 维护者：crazy-max（https://github.com/crazy-max/docker-linguist%EF%BC%89