repoview
v0.1.5
Published
GitHub-like repo browsing for local Git repositories (Markdown, live reload, broken link scanner).
Maintainers
Readme
repoview
GitHub-like repo browsing — without GitHub.
When platforms change pricing/terms (even for “bring-your-own-runner” CI), it’s a reminder that Git hosting can turn into a dependency and a risk. repoview keeps the day-to-day “GitHub UI” experience local: browse, read docs, and share a repo without pushing it anywhere.
Not affiliated with GitHub.
Features
- GitHub-like browsing for local repos (tree / file / raw views)
- GitHub-style Markdown rendering (README-friendly; close-to-GitHub)
- Live reload when files change (SSE with polling fallback)
- Broken internal link discovery for docs (
/broken-links) - Respects
.gitignoreby default (toggleable)
Quick start (from source)
npm install
npm start -- --repo /path/to/your/repo --port 3000Then open http://localhost:3000.
Quick start (npx)
From anywhere:
npx repoview --repo /path/to/your/repo --port 3000By default, repoview binds to 0.0.0.0 (LAN-accessible). For localhost-only:
npx repoview --repo /path/to/your/repo --host 127.0.0.1 --port 3000Why
- Keep GitHub as a remote, not your developer portal.
- Share private repos/docs on a LAN without pushing or mirroring.
- Work offline / in restricted networks with the same browsing UX.
Usage
npm start -- [--repo /path/to/repo] [--host 0.0.0.0] [--port 3000] [--no-watch]Common flags:
--repo: repo root--host,--port: bind address/port--no-watch: disable live reload + auto re-scan
Share on LAN (optional)
Bind to all interfaces, then open the host URL from another device:
npm start -- --repo /path/to/repo --host 0.0.0.0 --port 8890UI toggles
?ignored=1shows files ignored by the repo’s.gitignore(default: hidden)?watch=0disables browser auto-refresh for that tab
Development
- Implementation details:
DEVELOPMENT.md - CLI usage:
npm start -- --help
Troubleshooting
- Seeing
ENOENT .../node_modules/...in server logs: upgrade torepoview@>=0.1.2(older versions incorrectly looked for vendor assets inside the repo you’re serving).
Contributing
- Contributing guide:
CONTRIBUTING.md
License
MIT — see LICENSE.
