Updated by fix-consistency on 2026-05-16: - update .custodian-brief.md for guide-board
guide-board
guide-board is a certification and compliance preparation framework. It turns
standards, conformance, regulatory, and repository-quality claims into structured
evidence that can be reviewed, repeated, compared, and used during assessments.
The root project owns the framework contracts. Domain-specific work lives in extensions.
Local Baseline
The first core is intentionally dependency-light. From a clean checkout:
PYTHONPATH=src python3 -m guide_board extensions list
PYTHONPATH=src python3 -m guide_board extensions validate
PYTHONPATH=src python3 -m guide_board profile validate-target profiles/targets/sample-repository.json
PYTHONPATH=src python3 -m guide_board profile validate-assessment profiles/assessments/sample-noop.json
PYTHONPATH=src python3 -m guide_board plan \
--target profiles/targets/sample-repository.json \
--assessment profiles/assessments/sample-noop.json
PYTHONPATH=src python3 -m guide_board run \
--target profiles/targets/sample-repository.json \
--assessment profiles/assessments/sample-noop.json
PYTHONPATH=src python3 -m guide_board runs list
PYTHONPATH=src python3 -m guide_board runs trend
PYTHONPATH=src python3 -m guide_board runs gate
PYTHONPATH=src python3 -m guide_board serve --host 127.0.0.1 --port 8080
PYTHONPATH=src python3 -m unittest discover -s tests
External extension repos plug in with --extension-dir:
PYTHONPATH=src python3 -m guide_board --extension-dir ../open-cmis-tck extensions list
PYTHONPATH=src python3 -m guide_board --extension-dir ../open-cmis-tck plan \
--target ../open-cmis-tck/profiles/targets/kontextual-cmis-compat.json \
--assessment ../open-cmis-tck/profiles/assessments/cmis-browser-baseline.json
The same CLI contracts are packaged by the container baseline. See
docs/CONTAINER.md. The dependency-light local API wraps
those contracts for service and container operation; see
docs/LOCAL-SERVICE-API.md.
New runs write a richer sources.lock.json and
reports/submission-package.json alongside the assessment package so reviewers
can inspect source, metadata, artifact, and boundary references.
The sample-noop extension exercises the guide-board contracts without invoking
an external harness. sdk-fixture demonstrates the extension SDK contracts for
schemas, normalizers, mappings, and fixture profiles. open-cmis-tck is the
first real seed extension.
See:
- INTENT.md
- docs/ARCHITECTURE-BLUEPRINT.md
- docs/ASSESSMENT-OPERATIONS.md
- docs/CANDIDATE-HANDOFF.md
- docs/COMPLIANCE-EVIDENCE-PACKS.md
- docs/CONTAINER.md
- docs/EXTERNAL-EXTENSION-ACCEPTANCE.md
- docs/EXTENSION-SDK.md
- docs/LOCAL-SERVICE-API.md
- docs/SERVICE-JOB-DURABILITY.md
- extensions/CANDIDATES.md
- workplans/GUIDE-BOARD-WP-0001-bootstrapping.md
- workplans/GUIDE-BOARD-WP-0002-assessment-operations-baseline.md
- workplans/GUIDE-BOARD-WP-0003-extension-sdk-maturity.md
- workplans/GUIDE-BOARD-WP-0004-source-lock-and-submission-package-baseline.md
- workplans/GUIDE-BOARD-WP-0005-challenge-and-exclusion-handling.md
- workplans/GUIDE-BOARD-WP-0006-service-artifact-access-and-durable-run-index.md
- workplans/GUIDE-BOARD-WP-0007-report-and-export-maturity.md