Getting Started

What is gitinspect?

gitinspect is a CLI tool that turns any Git repository — local or remote — into a structured, token-efficient snapshot optimized for LLMs and AI agents. It works with any Git host without requiring a full clone.

Quick Install

macOS / Linux (curl)

curl -fsSL https://raw.githubusercontent.com/richie-rich90454/gitinspect/main/install.sh | bash

macOS / Linux (wget)

wget -qO- https://raw.githubusercontent.com/richie-rich90454/gitinspect/main/install.sh | bash

Homebrew

brew tap richie-rich90454/tap
brew install gitinspect

Windows (Scoop)

scoop bucket add gitinspect https://github.com/richie-rich90454/scoop-bucket
scoop install gitinspect

Go Install

go install github.com/richie-rich90454/gitinspect/cmd/gitinspect@latest

Your First Inspection

# Inspect the current directory
gitinspect inspect .

# Inspect a remote repository
gitinspect inspect https://github.com/user/repo.git

# Get plain text output
gitinspect inspect --format text --strip .

# Start as an MCP server for AI agents
gitinspect mcp

Next Steps

• Installation — detailed install options
• CLI Reference — all flags and commands
• MCP Integration — use with AI coding agents
• Examples — real-world usage patterns