Zigzag LogoZigZagDocs

Introduction

ZigZag - a blazing-fast code analytics tool that converts source code into comprehensive Markdown, JSON, and HTML reports.

Welcome to ZigZag

ZigZag is a blazing-fast code analytics tool that recursively scans your source code directories and produces comprehensive Markdown, JSON, and HTML reports — optimized for modern developer workflows and LLM-powered tooling.

At a Glance

  • Zero infrastructure — no servers, no vector databases, no API keys. One binary, one command.
  • LLM-optimized output — token-reduced reports with optional chunking for large codebases.
  • Real-time watch mode — rebuilds reports instantly on file changes.
  • Interactive HTML dashboard — syntax highlighting, virtual scrolling, charts, and dark mode.
  • Cross-platform — Linux, macOS, and Windows. Built with Zig for native performance.

Quick Start

# Install via Homebrew (macOS / Linux)
brew tap LegationPro/zigzag
brew install zigzag

# Initialize a config file
zigzag init

# Generate reports
zigzag run --paths ./src --html --json

# Watch for changes
zigzag run --paths ./src --watch --html

Ready to dive in? Head to the Getting Started guide for a full walkthrough.

On this page