winget install --id=imsncht.repo2page -e repo2page is a developer tool that converts an entire GitHub or local repository into a single, portable, structure-preserving document. It supports Markdown, HTML, and Plain Text output formats, respects .gitignore, and is distributed as a single binary with zero runtime dependencies.
repo2page is a developer tool that converts an entire GitHub or local repository into a single, portable, structure-preserving document.
It is designed to be simple, fast, and universally accessible, distributed as a single binary with zero runtime dependencies.
.md), HTML (.html), or Plain Text (.txt)..gitignore and comes with sensible default ignore patterns (e.g., node_modules, .git).curl -sfL https://raw.githubusercontent.com/imsncht/repo2page/main/scripts/install.sh | sh
brew tap imsncht/homebrew-tap
brew install repo2page
OR
brew install imsncht/homebrew-tap/repo2page
scoop bucket add imsncht https://github.com/imsncht/scoop-bucket.git
scoop install repo2page
winget install repo2page
Ensure you have Go 1.23+ installed.
go install github.com/imsncht/repo2page/cmd/repo2page@latest
(Note: Official binaries are available on the Releases page)
Convert a GitHub repository:
repo2page user/repo
# Output: repo.md
Convert a local directory:
repo2page ./my-project
# Output: my-project.md
repo2page [flags]
| Flag | Description | Default |
|---|---|---|
--format, -f | Output format (md, html, txt, json) | md |
--output, -o | Output file path (defaults to repo name + ext) | Auto |
--branch, -b | GitHub branch to fetch | main |
--summary, -s | Summary mode: only output tree structure | false |
--exclude, -e | Additional exclude patterns (glob) | [] |
--max-file-size | Max size per file in KB | 500 |
--no-tree | Disable directory tree visualization | false |
--json | Output stats/structure in JSON format | false |
--version, -v | Show version information | false |
Convert specific branch to HTML:
repo2page --format html --branch develop --output dev-docs.html user/repo
Exclude specific directories:
repo2page --exclude "dist/**" --exclude "test/**" ./my-local-project
Generate a summary of the repo structure only:
repo2page --summary user/repo
repo2page respects your .gitignore file automatically. It also includes comprehensive default ignore patterns for common build artifacts, lock files, and system files (e.g., .DS_Store, node_modules/, vendor/).
We welcome contributions! Please see CONTRIBUTING.md for guidelines on how to get started.