zigdoc

A command-line tool to view documentation for Zig standard library symbols.

Installation

zig build install -Doptimize=ReleaseFast --prefix $HOME/.local

Usage

Usage: zigdoc [options] <symbol>

Show documentation for Zig standard library symbols and imported modules.

zigdoc can access any module imported in your build.zig file, making it easy
to view documentation for third-party dependencies alongside the standard library.

Examples:
  zigdoc std.ArrayList
  zigdoc std.mem.Allocator
  zigdoc std.http.Server
  zigdoc 'std.multi_array_list.MultiArrayList.(insertBounded, appendAssumeCapacity, Slice.(get, set))'
  zigdoc vaxis.Window
  zigdoc zeit.timezone.Posix

Options:
  -h, --help        Show this help message
  --dump-imports    Dump module imports from build.zig as JSON

Commands:
  init              Initialize a new Zig project with AGENTS.md and skills
  skill install     Install skills into .agents/skills

Project Initialization

zigdoc init scaffolds a minimal Zig project with AGENTS.md, installs skills to .agents/skills, and creates build.zig plus build.zig.zon.

Skill installation downloads the latest zigdoc repository archive, so curl, unzip, and network access are required.

mkdir my-project && cd my-project
zigdoc init

Skill Installation

zigdoc skill install installs the repository skills into .agents/skills without creating or changing build.zig, build.zig.zon, or source files.

zigdoc skill install

Examples

# Standard library symbols
zigdoc std.ArrayList
zigdoc std.mem.Allocator
zigdoc std.http.Server

# Imported modules from build.zig
zigdoc zeit.timezone.Posix

Features

• View documentation for any public symbol in the Zig standard library
• Access documentation for imported modules from your build.zig
• Query multiple related symbols with grouped syntax like std.Type.(a, b, Nested.(c, d))
• Shows symbol location, category, and signature
• Displays doc comments, members, and member signatures/docs for type queries
• Follows aliases to implementation