@prisma_labs/atlas
v0.1.3
Published
Repo-owned evidence toolkit for canonical product surfaces.
Readme
Atlas
Atlas is a repo-owned evidence toolkit for canonical product surfaces.
Published consumer package:
@prisma_labs/atlas
It is built for two first-class users:
- agents that need a cheap machine-readable index of screens, flows, and provenance
- humans that need a static browser of the product without manually running the app
Wave 1 modules:
coreschema, run-report contract, promotion/sweep lifecycle, provenance, driftuistatic canonical screen evidenceflowmulti-step journey evidence, keyframes, contact sheets, poster frames, raw video/log refsviewer-reactreusable browser for dense gallery browsing and relationship tracingclistable commands for validation, render, promotion, sweep, and viewer build
This repo is the authoritative home for Atlas contracts, architecture, and adoption docs. Consumer repos keep only app-specific registry entries, capture wrappers, generated outputs, and operational policy.
Start here:
Preferred local commands:
bun install
bun run atlas:bootstrap
bun run atlas:test:core
bun run atlas:test:viewer-graph
bun run atlas:test:viewer-helpers
bun run atlas:test:viewer-build
bun run atlas:test
bun run atlas:validate
bun run atlas:render-index
bun run atlas:build-viewer
bun run atlas:publish -- --bump patch --dry-run
bun run checkConsumer install:
npm install --save-dev @prisma_labs/atlasConsumer repos should depend on the published package by default. Use this repo as the source of truth for Atlas development, contracts, docs, and releases.
Deterministic publish flow:
bun run atlas:publish -- --bump patch --dry-run
bun run atlas:publish -- --bump patch
bun run atlas:publish -- --version 0.2.0The publish script enforces:
- clean worktree
mainchecked outHEAD == origin/mainbefore bumpingbun run checknpm pack --dry-run- committed release version, matching git tag, npm publish, and registry verification
Viewer source of truth:
atlas/viewer/src/atlas/viewer/dist/is generated output and must not be edited directly- consumer repos should rebuild viewer assets instead of patching bundled
distfiles by hand
Primary env/config surface:
ATLAS_PROJECT_ROOTATLAS_ROOTATLAS_VIEWER_SRC_ROOTATLAS_VIEWER_TITLEATLAS_VIEWER_DESCRIPTIONATLAS_DEVICE_INSTALL_SCRIPTATLAS_SKIP_PUSH_CHECK
Atlas assumes consumer registry entries provide captureCommand values that emit the run-report JSON contract consumed by the promotion and sweep scripts.
For device-sensitive flows, Atlas also ships:
scripts/observe-device-flow.shscripts/install-connected-devices.shas a placeholder adapter
Consumer repos are expected to provide or override the device installer with app-specific logic.
