gitlab-pr-analyzer 0.9.3

GitLab MR & Commit Analyzer

中文文档 | English

A command-line tool for intelligently collecting, analyzing, and summarizing GitLab Merge Requests and commit records.

Installation & Setup

Prerequisites

• Python 3.8+
• GitLab access
  • GITLAB_HOST (e.g. https://gitlab.example.com)
  • GITLAB_TOKEN (PAT with read_api or api scope)

Recommended (optional)

• GitLab CLI (glab): recommended for better and faster diff retrieval
  • install and authenticate: glab auth login

Install GitLab CLI (glab)

• macOS (Homebrew):

brew install glab
glab auth login

• Linux (APT, Ubuntu/Debian):

sudo apt update
sudo apt install -y glab
glab auth login

• Windows (Winget):

winget install --id GitLab.glab
glab auth login

Daily usage tip: use the short command glpa (legacy: gl-pr-analyzer, gl-pr-ai).

Install

pip install gitlab-pr-analyzer

Configuration (Environment Variables)

Quick Start

# 0. Check connectivity (recommended after setting env vars)
glpa check

# 1. Interactive Mode (best for starting)
glpa interactive

# project path tip: from a URL like https://gitlab.example.com/group/subgroup/project use: --repo group/subgroup/project

# 2. Search with AI analysis (English output)
glpa search "authentication bug" --ai -r group/subgroup/project

# 3. Search with AI analysis (Chinese output)
glpa search "authentication bug" --ai -cn -r group/subgroup/project

# 4. Collect data
glpa collect --save-json -r group/subgroup/project

# 5. Generate report + export datasets
glpa traverse --days 7 --save-json -r group/subgroup/project

# optional: enable AI analysis for traverse
glpa traverse --days 7 --save-json --ai -cn -r group/subgroup/project

For detailed command usage, see USAGE.md.