Skip to content

README.md

Latest commit

 

History

History
77 lines (60 loc) · 2.96 KB

README.md

File metadata and controls

77 lines (60 loc) · 2.96 KB

scripts — Canonical Script Surface

The scripts/ root is intentionally compact.

Root Policy

  • Root directories are capped and domain-oriented.
  • Root files are capped at three:
    • README.md
    • catalog.yaml
    • run.py
  • Canonical logic lives in subpackages, not in root-level entrypoints.

Root Directories

  • scripts/ai — AI launchers, MCP tooling, and agent support.
  • scripts/data — compatibility data facade.
  • scripts/diagrams — diagram generation, linting, and render quality gates.
  • scripts/docs — documentation build, drift checks, fixers, and matrix tooling.
  • scripts/engineering — CI, dev, QA, diagnostics, baselines, and repo governance.
  • scripts/memory — Neo4j-backed project memory utilities.
  • scripts/ops — runtime, maintenance, observability, migration, and support tooling.
  • scripts/schema — schema generation and validation contracts.

Active vs Archive

  • Active operational commands live under scripts/ops and its canonical grouped entry points such as scripts.ops, scripts.ops.data, and scripts.engineering.baselines.
  • Historical material under scripts/ops/archive is retained for traceability only. It is discoverable through python scripts/run.py list under the archive group, but it is not the target surface for new integrations.

Canonical Entry Points

Use grouped module entrypoints where available:

python -m scripts.run --help
python scripts/run.py --help

python -m scripts.docs --help
python -m scripts.engineering.qa --help
python -m scripts.engineering.repo --help
python -m scripts.engineering.dev --help
python -m scripts.engineering.baselines --help
python -m scripts.ops --help
python -m scripts.memory --help
python -m scripts.diagrams --help
python -m scripts.schema --help
python -m scripts.ai --help

Frequently Used Commands

python -m scripts.engineering.qa report-dep-map --check
python -m scripts.docs build-site --strict
python -m scripts.engineering.repo check-catalog --catalog scripts/catalog.yaml
python -m scripts.engineering.repo check-inventory --check --manifest configs/quality/scripts_inventory_manifest.json
python -m scripts.engineering.baselines dq-baseline --dry-run
python -m scripts.ops rerender-grafana
python -m scripts.engineering.dev migrate-deprecated-names src/

Catalog

scripts/catalog.yaml is the governance manifest for canonical roots and group ownership. If you add or relocate script domains, update the catalog and rerun the repo governance checks.

Compatibility Policy

  • Historical root-level wrappers have been consolidated into canonical domain packages.
  • New integrations should target grouped module commands or canonical package paths only.
  • Archive-only paths under scripts/ops/archive/** are historical context and should not be used as canonical command targets.
  • Historical evidence under docs/reports/evidence/** may still mention removed paths; treat those references as archival, not canonical guidance.