Skip to content
github-actions[bot] edited this page Mar 21, 2026 · 5 revisions

wikigen

A single Go binary CLI that generates GitHub Wiki documentation from source code repositories using Claude Code. wikigen reads repository code via Claude Code's native tools (Read, Grep, Glob, Bash) and generates GitHub Wiki-compatible Markdown documentation. No Docker, Ollama, or embeddings required.

Generated: 2026-03-20 23:32:44

Pages

  • System Overview — Project purpose, what wikigen is, why it was created, and how it differs from other documentation generation tools. Technical stack and core components.
  • Architecture & Design — Overall system design: how wikigen orchestrates wiki generation, the relationship between structure determination and page generation phases, and how Claude Code is invoked. Processing pipeline and key data structures.
  • CLI Usage & Commands — Complete reference for all CLI flags and commands: single repo, batch mode, dry-run, JSON output, model selection, language, parallelism flags, and retry mode. Usage examples and patterns.
  • Configuration & Environment — Configuration via .env files, environment variables, and their relationship to CLI flags. Priority order (CLI flags override env vars). Complete list of all configurable options and their defaults.
  • Input Formats & Repository Configuration — repos.txt format and parsing: standalone wikis (one per repo) vs. multi-repo grouped wikis. Local directory support. Command-line positional arguments and file-based inputs.
  • Authentication & Git Integration — SSH vs. GitHub Personal Access Token (PAT) authentication methods. How repositories are cloned, git depth settings, and branch handling. Token configuration and HTTPS with token authentication.
  • Output Format & Wiki Structure — GitHub Wiki-compatible output directory structure: Home.md landing page, _Sidebar.md navigation, individual page files, and _errors.log. Output organization and file naming conventions.
  • Error Handling & Retry Mechanism — Automatic retry strategy (up to 3 attempts per page), error logging to _errors.log with timestamps, retry-only mode, partial result preservation, and failure detection thresholds.
  • Parallel Processing & Performance — Repository-level and page-level parallelism configuration (-p and -pp flags). Concurrency control via semaphores, sync.WaitGroup orchestration, and performance tuning recommendations.
  • Input Validation & Security — Repository format validation, path traversal protection, shell injection character blocking. Validation rules for remote repos and local directories. Security measures in input processing.
  • Build & Deployment — Building from source (Go 1.22+), cross-platform builds for Linux, macOS, and Windows. CI/CD setup via GitHub Actions, automatic wiki generation on push, release automation, and binary distribution.
  • Claude Code Integration — How wikigen uses Claude Code: invoking claude -p with --add-dir, passing repository directories, using Claude Code's native tools (Read, Grep, Glob, Bash). System prompts and tool interaction patterns.
  • Wiki Generation Processing Flow — Two-phase generation process: Phase 1 determines wiki structure (pages, titles, descriptions) via Claude Code, Phase 2 generates individual pages in parallel. Prompts, prompt engineering, XML parsing, and page content generation.
  • Multi-Repository Wiki Support — How wikigen supports grouping multiple repositories into a single wiki. Cross-repository documentation generation, inter-service interaction documentation, project naming and organization.
  • Progress Tracking & Output Modes — Real-time progress display with percentage completion, per-project and per-page status tracking. JSON output mode for scripting and automation. Log file output. Progress struct implementation.

Clone this wiki locally