@eonium/compass-create

Compass Create minimal scaffold generator for production-ready change workflow placeholders.

This package initializes the minimal repo-local Create working folders under .eonium/compass/create/:

.eonium/compass/create/specs/README.md
.eonium/compass/create/plans/README.md
.eonium/compass/create/runs/README.md
.eonium/compass/create/overlays/README.md
.eonium/compass/create/validation/README.md
.eonium/compass/create/finalize/README.md

Write behaviour

The initializer uses the shared Compass scaffold writer from @eonium/compass-core.

• If no mode is supplied, initialization defaults to dry-run and reports a warning.
• Dry-run mode reports the files that would be created or updated without writing .eonium files.
• Write mode creates missing Create placeholder files.
• Existing files are preserved by default.
• Already-current files are skipped.
• Existing files are updated only when force: true is supplied.
• The returned result includes files, scaffoldResults, changed, dryRun, force and the shared Compass change report.
• The returned report distinguishes created, updated, skipped, warned and errored files.

API

import { initCompassCreate } from "@eonium/compass-create";

const dryRun = initCompassCreate({ repoRoot: process.cwd() });
const write = initCompassCreate({ repoRoot: process.cwd(), mode: "write" });
const forced = initCompassCreate({ repoRoot: process.cwd(), mode: "write", force: true });

initCompassCreate() returns the generated file descriptors, per-file scaffold results, a boolean changed value and a Compass change report suitable for CLI orchestration.

Boundary

This package creates Create scaffold placeholders only.

It does not:

• implement the full Compass Create spec engine;
• implement the full Compass Create planning engine;
• execute Create runs;
• build production code;
• test target repos;
• create overlays or ZIP bundles;
• finalize releases;
• publish packages;
• call AI providers;
• host autonomous agents.

The full Create engines remain deferred to later implementation work. Until then, these placeholders provide stable repo-local locations for future specs, plans, runs, overlays, validation evidence and finalization records while preserving user-authored files by default.