Source Index is a small Go CLI for creating a local source-surface map of a repository before public review.
It follows a simple Unit27 posture: proof before claim, boundary before scale, review before release.
Source Index scans a local repository and reports whether common public-release surfaces are visible:
- README
- license
- CI workflow
- tests
- examples
- docs
- release checklist
It also flags visible boundary language and risky public-claim language in non-ignored files. The output is a Markdown report and a JSON report.
Source Index is not a verifier, fact-checker, fraud detector, certification system, compliance tool, legal tool, medical tool, or truth oracle.
It does not prove a repository is ready for release. It does not determine whether claims are true. It only makes visible repo surfaces, missing surfaces, boundary signals, and risky phrases easier to inspect.
Requirements:
- Go 1.26 or newer
Run the tests:
go test ./...Build the CLI:
go build ./cmd/source-indexScan the current repository:
./source-index -path . -out SOURCE_INDEX.md -json source_index.jsonScan the included synthetic demo repository:
go run ./cmd/source-index -path examples/demo_repo -out examples/generated/SOURCE_INDEX.md -json examples/generated/source_index.jsonThe Markdown report is intended for quick human review. The JSON report is intended for scripts, CI checks, or later tools.
The report includes:
- release-surface table
- boundary-signal list
- risk-language list
- ignored directory list
Source Index skips common generated or local-runtime directories:
.git, .next, build, coverage, dist, log, node_modules, storage, tmp, vendor
The demo files under examples/ are synthetic. They do not include private, client, employer, recruiter, school, family, or personal data.
Source Index is a local review aid. It can point to visible files and phrases, but it does not certify release readiness or prove authenticity.