Skip to content

Start typing to search the documentation.

Map

AI-generated, awaiting review View as Markdown

bapX map owns project map generation. Do not add standalone map scripts or parallel map files.

Usage

bapX map --root <path>
bapX map --root <path> --check

--check validates that <path>/map.mmd exists and matches the map generated from the current source layout.

Profiles

Profiles add required-file checks on top of map freshness.

bapX map --root demo --check --profile demo-project
bapX map --root /root/bapx.in/users/<user> --check --profile user-workspace
bapX map --root /root/bapx.in/users/<user>/<business-slug> --check --profile business-workspace
bapX map --root /root/bapx.in/users/<user>/<business-slug>/projects/<project-name-slug> --check --profile user-project

demo-project requires OKF.md, README.md, map.mmd, docs/index.md, docs/map.mmd, src/, and src/lib/bapX-client.ts.

user-workspace requires .git/, OKF.md, index.md, and map.mmd.

business-workspace requires index.md, map.mmd, DESIGN.md, brand.css, logos/index.md, logos/map.mmd, projects/index.md, and projects/map.mmd.

user-project requires index.md, map.mmd, docs/, docs/index.md, and docs/map.mmd.

Map validation does not replace browser tests, package tests, or source inspection. Use it as the structure check before release evidence.