Andy Dixon ae8b0a6b80 Add City mode: codebase laid out as streets and buildings
city.js lays the directory tree out at human scale: top-level folders
become districts separated by 18 m avenues, nested folders become
blocks with narrower streets and raised pavements, and files become
buildings whose footprint follows their lines and whose height follows
their complexity. The squarified treemap moves into city.js and is
shared with the landscape.

The renderer gains a second instance layer with per-instance kind,
code-atlas rectangle and selection flag, a helicopter camera in metres,
screen-to-world rays, and geometry lookup per mode. City mode supports
orbit, pan, dolly, ray picking, focusing a building and district names.
Node tests cover layout invariants, heights, ray/box hits and the
spatial index.
2026-05-10 15:50:23 +01:00
2026-01-24 14:08:43 +00:00
2026-02-01 21:48:24 +00:00
2026-02-01 21:48:24 +00:00
2026-01-24 14:08:43 +00:00
2026-04-12 15:04:26 +01:00
2026-04-12 15:04:26 +01:00

CodeNavigator

A single binary that serves the WebGL frontend and the indexing API (jobs, SSE progress, snapshots, search, source) on one origin. No dependencies beyond the Go standard library.

go run .                 # http://127.0.0.1:4177
go test -race ./...
go test -run x -bench Index   # indexes $CODENAV_BENCH_DIR (default: Go's stdlib source)
./build.sh [tag]         # Docker image, tests run during the build
docker run --rm -p 4177:4177 codenavigator:latest

Configuration:

  • PORT (default 4177, or --port), CORS_ORIGIN (default *)
  • GITHUB_CLIENT_ID, GITHUB_CLIENT_SECRET: a GitHub App's credentials; enables sign-in for private repositories
  • GITHUB_APP_SLUG: the app's URL name, for the "grant repository access" link

git must be on PATH to load GitHub repositories (the image includes it).

Multiple users

Every browser gets an HttpOnly session cookie. Jobs, snapshots and GitHub sign-ins belong to that session and are invisible (404) to others. Each session keeps its latest snapshot; snapshots idle for an hour are deleted, at most 8 are held (least recently used evicted), and two indexes run at once while the rest queue. State is in memory, so a restart signs everyone out.

Private GitHub repositories

Uses a GitHub App's user authorisation. When an anonymous clone fails, the frontend offers Sign in with GitHub; the callback (/api/github/callback) stores an 8-hour user token in memory for the session. Clones send it as an HTTP header via environment git config, never in the URL or arguments, and host git config and credential helpers are ignored. A signed-in user can only open repositories where the app is installed and they have access, otherwise the frontend links to the app's installation page.

GitHub App settings: callback URL https://<host>/api/github/callback, setup URL https://<host>/ with "Redirect on update", token expiry on, no webhook, repository permission Contents: read-only.

The browser frontend in web/ is plain JavaScript (it has to run in the browser) and is embedded into the binary; web/config.js points it at the same origin.

Notes:

  • GET / serves the frontend instead of a JSON service description.
  • Jobs and snapshots are private to the browser session that created them (see above).
  • Search queries are percent-decoded properly.
  • .gitignore support covers standard globs but not global excludes or .git/info/exclude.
S
Description
See your code as a city: explore any GitHub repo as a 2D map, 3D landscape or walkable city. Single Go binary + WebGL2.
Readme GPL-3.0
7.6 MiB
Languages
JavaScript 64.8%
Go 21.2%
CSS 9.9%
HTML 3.9%
Dockerfile 0.1%