Handbook

Workspace setup — Scan and host setup

Operational steps: environment variable, optional registry, and host-repo layout for Lenses caches.

What it is

Operational steps: environment variable, optional registry, and host-repo layout for Lenses caches.

Parent: Workspace setup.

Steps

  1. Prefer an environment variable — Set LENSES_WORKSPACE_ROOT to the parent folder that contains your clones (the directory that lists forge-lenses/ next to other repos). Restart the server after changing it.

  2. Optional registry — Some teams use a small workspace-registry.json at the forge-lenses repo root to label repos and tune scanning. You only need this if your team already standardized on it; otherwise start without it.

  3. Host-repo layout — When forge-lenses is a submodule of a product repo, run ./scripts/lenses-startup.sh once from the documented flow so .lenses-local/ and .lenses-repo/<login>/ are created at the host root (not inside forge-lenses/). That keeps local caches and shared notes where your team expects them.

Desktop app and JSON config details for workspace resolution are documented for operators in the forge-lenses repository on GitHub (maintainer documentation).

What to do next