Skip to content

User guide

Task-oriented documentation for people using GitIntel day to day. For exhaustive flag lists see the CLI reference; for the meaning behind the numbers see Core concepts.

  • :material-chart-box: Analyzing repositories

    Repository-wide summaries, contributors, activity, and health.

  • :material-account-check: Ownership analysis

    Who works on which files, filtering, and reviewer selection.

  • :material-fire: Hotspot analysis

    Ranking risk and acting on the results.

  • :material-code-json: Output formats

    table, json, markdown — and how to pipe them safely.

  • :material-robot: Automation and CI

    GitHub Actions, pre-merge reports, scheduled snapshots.

  • :material-check-decagram: Best practices

    Interpreting metrics honestly and running on large repositories.

Invocation shape

gitintel [GLOBAL OPTIONS] COMMAND [ARGUMENT] [COMMAND OPTIONS]

gitintel --quiet ownership /srv/api --all --format json
#        └ global ┘ └ cmd ┘ └ arg ┘ └ command options ┘

Global options (--quiet, --version, --help) must precede the command name; command options follow it. The gitit alias is interchangeable with gitintel everywhere.