@c9up/atlas 0.1.19 → 0.2.1

package/dist/console/factoryCommands.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Factory console command — `make:factory` (Adonis Lucid). Scaffolds a model
+ * factory file. Same shape as the migration/seeder commands: a plain
+ * `{ name, description, run }` object registered in `reamrc.commands`.
+ *
+ * @example
+ *   // commands/make-factory.ts
+ *   import { makeFactoryCommand } from '@c9up/atlas'
+ *   export default makeFactoryCommand({ factoriesDir: 'database/factories' })
+ *   // run:  <console-entry> make:factory User
+ */
+import { type AtlasCommandClass } from "./contract.js";
+export interface FactoryCommandOptions {
+    /** Directory the factory files are scaffolded into. */
+    factoriesDir: string;
+}
+/**
+ * `make:factory <Model>` — scaffold `<Model>Factory.ts` in `factoriesDir`. The
+ * name is validated (no path separators / traversal) and written with `wx` so an
+ * existing factory is never clobbered.
+ */
+export declare function makeFactoryCommand(options: FactoryCommandOptions): AtlasCommandClass;
+//# sourceMappingURL=factoryCommands.d.ts.map

package/dist/console/factoryCommands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factoryCommands.d.ts","sourceRoot":"","sources":["../../src/console/factoryCommands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAMH,OAAO,EAAE,KAAK,iBAAiB,EAAY,MAAM,eAAe,CAAC;AAEjE,MAAM,WAAW,qBAAqB;IACrC,uDAAuD;IACvD,YAAY,EAAE,MAAM,CAAC;CACrB;AAaD;;;;GAIG;AACH,wBAAgB,kBAAkB,CACjC,OAAO,EAAE,qBAAqB,GAC5B,iBAAiB,CA+BnB"}

package/dist/console/factoryCommands.js

@@ -0,0 +1,62 @@
+/**
+ * Factory console command — `make:factory` (Adonis Lucid). Scaffolds a model
+ * factory file. Same shape as the migration/seeder commands: a plain
+ * `{ name, description, run }` object registered in `reamrc.commands`.
+ *
+ * @example
+ *   // commands/make-factory.ts
+ *   import { makeFactoryCommand } from '@c9up/atlas'
+ *   export default makeFactoryCommand({ factoriesDir: 'database/factories' })
+ *   // run:  <console-entry> make:factory User
+ */
+import * as fsp from "node:fs/promises";
+import * as path from "node:path";
+import { camelToSnake } from "../utils/casing.js";
+import { assertSafeName } from "../utils/safePath.js";
+import { argument } from "./contract.js";
+/** Scaffold body for a fresh factory (`make:factory <Model>`). */
+function factoryStub(model) {
+    return `import { factory } from '@c9up/atlas'
+import ${model} from '#models/${model.toLowerCase()}'
+
+export const ${model}Factory = factory(${model}, ({ faker }) => ({
+  // email: faker.internet.email(),
+}))
+`;
+}
+/**
+ * `make:factory <Model>` — scaffold `<Model>Factory.ts` in `factoriesDir`. The
+ * name is validated (no path separators / traversal) and written with `wx` so an
+ * existing factory is never clobbered.
+ */
+export function makeFactoryCommand(options) {
+    return class MakeFactory {
+        static commandName = "make:factory";
+        static description = "Scaffold a new model factory file";
+        // Pure filesystem work: no reason to boot the app and open a connection.
+        static options = { startApp: false };
+        static args = [
+            argument("model", { description: "Model the factory is built for" }),
+        ];
+        async run() {
+            // A missing model is caught by the kernel before `run()` — it reports
+            // the required argument by name, so there is no usage check here.
+            // Lucid convention: `make:factory User` → `user_factory.ts`
+            // (`BlogPost` → `blog_post_factory.ts`).
+            const fileName = `${camelToSnake(this.model)}_factory.ts`;
+            try {
+                assertSafeName(fileName, "FACTORY_INVALID", "factory");
+            }
+            catch {
+                console.error(`[atlas] invalid factory name: ${this.model}`);
+                process.exitCode = 1;
+                return;
+            }
+            const filePath = path.join(options.factoriesDir, fileName);
+            await fsp.mkdir(options.factoriesDir, { recursive: true });
+            await fsp.writeFile(filePath, factoryStub(this.model), { flag: "wx" });
+            console.log(`Created ${filePath}`);
+        }
+    };
+}
+//# sourceMappingURL=factoryCommands.js.map

package/dist/console/factoryCommands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"factoryCommands.js","sourceRoot":"","sources":["../../src/console/factoryCommands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAC;AACxC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAA0B,QAAQ,EAAE,MAAM,eAAe,CAAC;AAOjE,kEAAkE;AAClE,SAAS,WAAW,CAAC,KAAa;IACjC,OAAO;SACC,KAAK,kBAAkB,KAAK,CAAC,WAAW,EAAE;;eAEpC,KAAK,qBAAqB,KAAK;;;CAG7C,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CACjC,OAA8B;IAE9B,OAAO,MAAM,WAAW;QACvB,MAAM,CAAC,WAAW,GAAG,cAAc,CAAC;QACpC,MAAM,CAAC,WAAW,GAAG,mCAAmC,CAAC;QACzD,yEAAyE;QACzE,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,GAAG;YACb,QAAQ,CAAC,OAAO,EAAE,EAAE,WAAW,EAAE,gCAAgC,EAAE,CAAC;SACpE,CAAC;QAIF,KAAK,CAAC,GAAG;YACR,sEAAsE;YACtE,kEAAkE;YAClE,4DAA4D;YAC5D,yCAAyC;YACzC,MAAM,QAAQ,GAAG,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC;YAC1D,IAAI,CAAC;gBACJ,cAAc,CAAC,QAAQ,EAAE,iBAAiB,EAAE,SAAS,CAAC,CAAC;YACxD,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO,CAAC,KAAK,CAAC,iCAAiC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;gBAC7D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,OAAO;YACR,CAAC;YACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;YAC3D,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC3D,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;QACpC,CAAC;KACD,CAAC;AACH,CAAC"}

package/dist/console/migrationCommands.d.ts

@@ -0,0 +1,78 @@
+/**
+ * Migration console commands — the Ream-idiomatic CLI for running, rolling back,
+ * inspecting, and wiping migrations. Same shape and contract as
+ * {@link schemaCheckCommand}: plain `{ name, description, run }` objects
+ * registered in `reamrc.commands` and dispatched by the console kernel.
+ *
+ * Each command resolves the live connection from atlas's OWN service locator
+ * (`getDb`), never importing `@c9up/ream`, and drives the already-tested
+ * {@link MigrationRunner}. Atlas has no global config registry (Lucid parity —
+ * you pass your own paths), so every factory takes the `migrationsDir`.
+ *
+ * @example
+ *   // commands/migrate.ts
+ *   import { migrationRunCommand } from '@c9up/atlas'
+ *   export default migrationRunCommand({ migrationsDir: 'database/migrations' })
+ *
+ *   // reamrc.ts → commands: [() => import('./commands/migrate.js')]
+ *   // run:  <console-entry> migration:run
+ */
+import { type AtlasCommandClass } from "./contract.js";
+import { type SchemaGenerateOptions } from "./schemaGenerateCommand.js";
+export interface MigrationCommandOptions {
+    /** Directory holding the numbered migration files. */
+    migrationsDir: string;
+    /**
+     * Sort migration files numerically (`2_x` before `10_x`). Adonis Lucid
+     * `migrations.naturalSort`. Defaults to `false`.
+     */
+    naturalSort?: boolean;
+    /**
+     * Run every migration outside a transaction. Adonis Lucid
+     * `migrations.disableTransactions`. A migration can also opt out with
+     * `static disableTransactions = true`. Defaults to `false`.
+     */
+    disableTransactions?: boolean;
+    /**
+     * Regenerate the schema file after a mutating migration command
+     * (run/rollback/reset/refresh/fresh) — Adonis Lucid's post-migration
+     * `schema:generate`. Off unless an `outputPath` is given; on by default once
+     * it is, unless `enabled: false`; suppress per-run with `--no-schema-generate`.
+     */
+    schemaGeneration?: SchemaGenerateOptions;
+    /**
+     * Default schema-dump path auto-loaded by `migration:run` / `migration:fresh`
+     * when the target DB has no applied migrations (Adonis Lucid bootstraps from
+     * the dump by default). Overridden per-run by `--schema-path`; a run never
+     * loads it once migrations exist.
+     */
+    schemaPath?: string;
+}
+/** `migration:run` — apply every pending migration. */
+export declare function migrationRunCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/**
+ * `migration:rollback` — undo the latest batch, or with `--batch=N` roll back
+ * everything applied after batch N (`--batch=0` rolls back all).
+ */
+export declare function migrationRollbackCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/** `migration:status` — list every migration and whether it is applied. */
+export declare function migrationStatusCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/** `migration:reset` — roll back every applied migration. */
+export declare function migrationResetCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/** `migration:unlock` — force-clear a stuck migration lock (Lucid `migration:unlock`). */
+export declare function migrationUnlockCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/** `migration:fresh` — drop every table, then re-run all migrations (Lucid `migration:fresh`). */
+export declare function migrationFreshCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/** `migration:refresh` — roll everything back, then re-run all migrations. */
+export declare function migrationRefreshCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/** `db:wipe` — drop every table, including the migrations bookkeeping table. */
+export declare function dbWipeCommand(options: MigrationCommandOptions): AtlasCommandClass;
+/**
+ * `make:migration <name>` — scaffold a timestamped migration file in
+ * `migrationsDir`. The `Date.now()` prefix keeps files in creation order under
+ * the runner's lexicographic sort (same convention as AdonisJS/Lucid). The name
+ * is validated (no path separators / traversal) and the file is written with
+ * `wx` so an existing migration is never clobbered.
+ */
+export declare function makeMigrationCommand(options: MigrationCommandOptions): AtlasCommandClass;
+//# sourceMappingURL=migrationCommands.d.ts.map

package/dist/console/migrationCommands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrationCommands.d.ts","sourceRoot":"","sources":["../../src/console/migrationCommands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAWH,OAAO,EAAE,KAAK,iBAAiB,EAAkB,MAAM,eAAe,CAAC;AACvE,OAAO,EAEN,KAAK,qBAAqB,EAC1B,MAAM,4BAA4B,CAAC;AAEpC,MAAM,WAAW,uBAAuB;IACvC,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,qBAAqB,CAAC;IACzC;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AA+CD,uDAAuD;AACvD,wBAAgB,mBAAmB,CAClC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CAuBnB;AAED;;;GAGG;AACH,wBAAgB,wBAAwB,CACvC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CAuCnB;AAED,2EAA2E;AAC3E,wBAAgB,sBAAsB,CACrC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CAoBnB;AAED,6DAA6D;AAC7D,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CAuBnB;AAED,0FAA0F;AAC1F,wBAAgB,sBAAsB,CACrC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CAenB;AAED,kGAAkG;AAClG,wBAAgB,qBAAqB,CACpC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CA2BnB;AAED,8EAA8E;AAC9E,wBAAgB,uBAAuB,CACtC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CAqBnB;AAED,gFAAgF;AAChF,wBAAgB,aAAa,CAC5B,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CAiBnB;AAkBD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CACnC,OAAO,EAAE,uBAAuB,GAC9B,iBAAiB,CA2BnB"}

package/dist/console/migrationCommands.js

@@ -0,0 +1,327 @@
+/**
+ * Migration console commands — the Ream-idiomatic CLI for running, rolling back,
+ * inspecting, and wiping migrations. Same shape and contract as
+ * {@link schemaCheckCommand}: plain `{ name, description, run }` objects
+ * registered in `reamrc.commands` and dispatched by the console kernel.
+ *
+ * Each command resolves the live connection from atlas's OWN service locator
+ * (`getDb`), never importing `@c9up/ream`, and drives the already-tested
+ * {@link MigrationRunner}. Atlas has no global config registry (Lucid parity —
+ * you pass your own paths), so every factory takes the `migrationsDir`.
+ *
+ * @example
+ *   // commands/migrate.ts
+ *   import { migrationRunCommand } from '@c9up/atlas'
+ *   export default migrationRunCommand({ migrationsDir: 'database/migrations' })
+ *
+ *   // reamrc.ts → commands: [() => import('./commands/migrate.js')]
+ *   // run:  <console-entry> migration:run
+ */
+import * as fsp from "node:fs/promises";
+import * as path from "node:path";
+import { MigrationRunner, } from "../schema/MigrationRunner.js";
+import { getDb } from "../services/db.js";
+import { assertSafeName } from "../utils/safePath.js";
+import { argument, flag } from "./contract.js";
+import { generateSchemaFile, } from "./schemaGenerateCommand.js";
+/**
+ * Adapt the shared singleton connection to the runner's {@link DatabaseAdapter}.
+ * `close()` is intentionally a no-op — the console kernel owns the connection's
+ * lifecycle, so a command must not tear down a connection other commands share.
+ */
+function toAdapter(conn) {
+    return {
+        execute: async (sql, params) => {
+            await conn.execute(sql, params);
+        },
+        query: (sql, params) => conn.query(sql, params),
+        runInTransaction: (batch) => conn.runInTransaction(batch),
+        // Thread the connection's managed interactive transaction through so the
+        // runner can make this.defer() atomic and restore MySQL FK checks.
+        transaction: conn.transaction?.bind(conn),
+        close: async () => { },
+    };
+}
+/**
+ * Resolve a runner from the live connection, or report and set a failing exit
+ * code when no connection is registered (mirrors `schemaCheckCommand`).
+ */
+function resolveRunner(options) {
+    const db = getDb();
+    if (!db) {
+        console.error("[atlas] no database connection — is AtlasProvider registered?");
+        process.exitCode = 1;
+        return undefined;
+    }
+    // Pass the connection's ACTUAL dialect — without it the runner defaults to
+    // sqlite and emits SQLite SQL (lock table, FK handling, DDL) against a
+    // Postgres/MySQL database.
+    return new MigrationRunner(toAdapter(db), {
+        migrationsDir: options.migrationsDir,
+        dialect: db.dialect,
+        naturalSort: options.naturalSort,
+        disableTransactions: options.disableTransactions,
+    });
+}
+/** `migration:run` — apply every pending migration. */
+export function migrationRunCommand(options) {
+    return class MigrationRun {
+        static commandName = "migration:run";
+        static description = "Run all pending migrations (--schema-path to bootstrap from a dump)";
+        static options = { startApp: true };
+        static flags = [schemaPathOption(), noSchemaGenerateFlag()];
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            const ran = await runner.migrate({
+                schemaPath: this.schemaPath ?? options.schemaPath,
+            });
+            console.log(ran.length ? `Migrated: ${ran.join(", ")}` : "Already up to date");
+            await maybeRegenSchema(options, this);
+        }
+    };
+}
+/**
+ * `migration:rollback` — undo the latest batch, or with `--batch=N` roll back
+ * everything applied after batch N (`--batch=0` rolls back all).
+ */
+export function migrationRollbackCommand(options) {
+    return class MigrationRollback {
+        static commandName = "migration:rollback";
+        static description = "Roll back the latest batch (or --batch=N; --force in prod)";
+        static options = { startApp: true };
+        static flags = [
+            flag("batch", "number", {
+                description: "Roll back everything applied after batch N (0 = all)",
+            }),
+            forceFlag(),
+            noSchemaGenerateFlag(),
+        ];
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            const batch = parseBatchFlag(this.batch);
+            if (batch === "invalid") {
+                console.error("[atlas] --batch must be a non-negative integer");
+                process.exitCode = 1;
+                return;
+            }
+            const force = this.force === true;
+            const rolled = await runner.rollback(batch === undefined ? { force } : { batch, force });
+            console.log(rolled.length
+                ? `Rolled back: ${rolled.join(", ")}`
+                : "Nothing to roll back");
+            await maybeRegenSchema(options, this);
+        }
+    };
+}
+/** `migration:status` — list every migration and whether it is applied. */
+export function migrationStatusCommand(options) {
+    return class MigrationStatus {
+        static commandName = "migration:status";
+        static description = "Show applied and pending migrations";
+        static options = { startApp: true };
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            const rows = await runner.status();
+            if (rows.length === 0) {
+                console.log("No migrations found");
+                return;
+            }
+            for (const row of rows) {
+                const batch = row.batch === undefined ? "" : ` (batch ${row.batch})`;
+                console.log(`${row.status.padEnd(8)} ${row.name}${batch}`);
+            }
+        }
+    };
+}
+/** `migration:reset` — roll back every applied migration. */
+export function migrationResetCommand(options) {
+    return class MigrationReset {
+        static commandName = "migration:reset";
+        static description = "Roll back all migrations (--force to override prod guard)";
+        static options = { startApp: true };
+        static flags = [forceFlag(), noSchemaGenerateFlag()];
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            const rolled = await runner.reset({ force: this.force === true });
+            console.log(rolled.length
+                ? `Rolled back: ${rolled.join(", ")}`
+                : "Nothing to reset");
+            await maybeRegenSchema(options, this);
+        }
+    };
+}
+/** `migration:unlock` — force-clear a stuck migration lock (Lucid `migration:unlock`). */
+export function migrationUnlockCommand(options) {
+    return class MigrationUnlock {
+        static commandName = "migration:unlock";
+        static description = "Force-clear a stuck migration lock";
+        static options = { startApp: true };
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            const cleared = await runner.forceUnlock();
+            console.log(cleared ? "Migration lock cleared" : "No migration lock was held");
+        }
+    };
+}
+/** `migration:fresh` — drop every table, then re-run all migrations (Lucid `migration:fresh`). */
+export function migrationFreshCommand(options) {
+    return class MigrationFresh {
+        static commandName = "migration:fresh";
+        static description = "Drop all tables, then re-run every migration (--force to override prod guard)";
+        static options = { startApp: true };
+        static flags = [forceFlag(), schemaPathOption(), noSchemaGenerateFlag()];
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            const { executed } = await runner.fresh({
+                force: this.force === true,
+                schemaPath: this.schemaPath ?? options.schemaPath,
+            });
+            console.log(executed.length
+                ? `Dropped all tables, re-ran: ${executed.join(", ")}`
+                : "Dropped all tables (no migrations to run)");
+            await maybeRegenSchema(options, this);
+        }
+    };
+}
+/** `migration:refresh` — roll everything back, then re-run all migrations. */
+export function migrationRefreshCommand(options) {
+    return class MigrationRefresh {
+        static commandName = "migration:refresh";
+        static description = "Roll back all migrations, then re-run them (--force to override prod guard)";
+        static options = { startApp: true };
+        static flags = [forceFlag(), noSchemaGenerateFlag()];
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            const { rolled, executed } = await runner.refresh({
+                force: this.force === true,
+            });
+            console.log(`Rolled back: ${rolled.length}, re-ran: ${executed.length}`);
+            await maybeRegenSchema(options, this);
+        }
+    };
+}
+/** `db:wipe` — drop every table, including the migrations bookkeeping table. */
+export function dbWipeCommand(options) {
+    return class DbWipe {
+        static commandName = "db:wipe";
+        static description = "Drop all tables including the migrations table (--force to override prod guard)";
+        static options = { startApp: true };
+        static flags = [forceFlag()];
+        async run() {
+            const runner = resolveRunner(options);
+            if (!runner)
+                return;
+            await runner.wipe({ force: this.force === true });
+            console.log("Dropped all tables");
+        }
+    };
+}
+/** Scaffold body for a fresh migration (`make:migration`). */
+const MIGRATION_STUB = `import { Migration } from '@c9up/atlas'
+
+export default class extends Migration {
+  async up() {
+    // this.schema.createTable('table_name', (table) => {
+    //   table.increments('id')
+    // })
+  }
+
+  async down() {
+    // this.schema.dropTable('table_name')
+  }
+}
+`;
+/**
+ * `make:migration <name>` — scaffold a timestamped migration file in
+ * `migrationsDir`. The `Date.now()` prefix keeps files in creation order under
+ * the runner's lexicographic sort (same convention as AdonisJS/Lucid). The name
+ * is validated (no path separators / traversal) and the file is written with
+ * `wx` so an existing migration is never clobbered.
+ */
+export function makeMigrationCommand(options) {
+    return class MakeMigration {
+        static commandName = "make:migration";
+        static description = "Scaffold a new timestamped migration file";
+        // Filesystem only — no connection needed.
+        static options = { startApp: false };
+        static args = [argument("name", { description: "Migration file name" })];
+        async run() {
+            // A missing name never reaches here: the kernel reports the required
+            // argument by name before `run()`.
+            try {
+                assertSafeName(this.name, "MIGRATION_INVALID", "migration");
+            }
+            catch {
+                console.error(`[atlas] invalid migration name: ${this.name}`);
+                process.exitCode = 1;
+                return;
+            }
+            const fileName = `${Date.now()}_${this.name}.ts`;
+            const filePath = path.join(options.migrationsDir, fileName);
+            await fsp.mkdir(options.migrationsDir, { recursive: true });
+            await fsp.writeFile(filePath, MIGRATION_STUB, { flag: "wx" });
+            console.log(`Created ${filePath}`);
+        }
+    };
+}
+/**
+ * Flags shared by several migration commands.
+ *
+ * Declared per command rather than inherited: `migration:status` takes neither
+ * `--force` nor `--schema-path`, and listing them anyway would put flags in its
+ * help that it ignores.
+ */
+const forceFlag = () => flag("force", "boolean", {
+    description: "Override the production guard",
+});
+const schemaPathOption = () => flag("schemaPath", "string", {
+    description: "Bootstrap from a schema dump before migrating",
+});
+const noSchemaGenerateFlag = () => flag("noSchemaGenerate", "boolean", {
+    description: "Skip regenerating the schema file afterwards",
+});
+/**
+ * Regenerate the schema file after a mutating migration command (Adonis Lucid's
+ * post-migration `schema:generate`) — unless it's disabled, has no `outputPath`,
+ * or the run passed `--no-schema-generate`.
+ */
+async function maybeRegenSchema(options, command) {
+    const cfg = options.schemaGeneration;
+    // Opt-in by configuring an outputPath; then ON unless explicitly disabled —
+    // Adonis Lucid presents `enabled: false` as the OFF switch (default on).
+    if (!cfg?.outputPath || cfg.enabled === false)
+        return;
+    if (command.noSchemaGenerate === true)
+        return;
+    const db = getDb();
+    if (!db)
+        return;
+    const n = await generateSchemaFile(db, cfg);
+    console.log(`Regenerated ${cfg.outputPath} (${n} table${n === 1 ? "" : "s"})`);
+}
+/**
+ * Parse the `--batch` flag: absent → undefined (default rollback), a
+ * non-negative integer string → that number, anything else → `"invalid"`.
+ */
+function parseBatchFlag(value) {
+    // The kernel already rejected a non-numeric `--batch`; what is left to check
+    // is that the number is a non-negative integer.
+    if (value === undefined)
+        return undefined;
+    return Number.isInteger(value) && value >= 0 ? value : "invalid";
+}
+//# sourceMappingURL=migrationCommands.js.map

package/dist/console/migrationCommands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"migrationCommands.js","sourceRoot":"","sources":["../../src/console/migrationCommands.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;GAkBG;AAEH,OAAO,KAAK,GAAG,MAAM,kBAAkB,CAAC;AACxC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAElC,OAAO,EAEN,eAAe,GACf,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAA0B,QAAQ,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACvE,OAAO,EACN,kBAAkB,GAElB,MAAM,4BAA4B,CAAC;AAgCpC;;;;GAIG;AACH,SAAS,SAAS,CAAC,IAA6B;IAC/C,OAAO;QACN,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE;YAC9B,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACjC,CAAC;QACD,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,CAAC;QAC/C,gBAAgB,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC;QACzD,yEAAyE;QACzE,mEAAmE;QACnE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC;QACzC,KAAK,EAAE,KAAK,IAAI,EAAE,GAAE,CAAC;KACrB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CACrB,OAAgC;IAEhC,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CACZ,+DAA+D,CAC/D,CAAC;QACF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,2EAA2E;IAC3E,uEAAuE;IACvE,2BAA2B;IAC3B,OAAO,IAAI,eAAe,CAAC,SAAS,CAAC,EAAE,CAAC,EAAE;QACzC,aAAa,EAAE,OAAO,CAAC,aAAa;QACpC,OAAO,EAAE,EAAE,CAAC,OAAO;QACnB,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,mBAAmB,EAAE,OAAO,CAAC,mBAAmB;KAChD,CAAC,CAAC;AACJ,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,mBAAmB,CAClC,OAAgC;IAEhC,OAAO,MAAM,YAAY;QACxB,MAAM,CAAC,WAAW,GAAG,eAAe,CAAC;QACrC,MAAM,CAAC,WAAW,GACjB,qEAAqE,CAAC;QACvE,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,CAAC,gBAAgB,EAAE,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAK5D,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;gBAChC,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU;aACjD,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CACV,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,CACjE,CAAC;YACF,MAAM,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC;KACD,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACvC,OAAgC;IAEhC,OAAO,MAAM,iBAAiB;QAC7B,MAAM,CAAC,WAAW,GAAG,oBAAoB,CAAC;QAC1C,MAAM,CAAC,WAAW,GACjB,4DAA4D,CAAC;QAC9D,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG;YACd,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE;gBACvB,WAAW,EAAE,sDAAsD;aACnE,CAAC;YACF,SAAS,EAAE;YACX,oBAAoB,EAAE;SACtB,CAAC;QAMF,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,KAAK,GAAG,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACzB,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;gBAChE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,OAAO;YACR,CAAC;YACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC;YAClC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CACnC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAClD,CAAC;YACF,OAAO,CAAC,GAAG,CACV,MAAM,CAAC,MAAM;gBACZ,CAAC,CAAC,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACrC,CAAC,CAAC,sBAAsB,CACzB,CAAC;YACF,MAAM,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC;KACD,CAAC;AACH,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,sBAAsB,CACrC,OAAgC;IAEhC,OAAO,MAAM,eAAe;QAC3B,MAAM,CAAC,WAAW,GAAG,kBAAkB,CAAC;QACxC,MAAM,CAAC,WAAW,GAAG,qCAAqC,CAAC;QAC3D,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAEpC,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;YACnC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,CAAC;gBACnC,OAAO;YACR,CAAC;YACD,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,GAAG,CAAC,KAAK,GAAG,CAAC;gBACrE,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,IAAI,GAAG,KAAK,EAAE,CAAC,CAAC;YAC5D,CAAC;QACF,CAAC;KACD,CAAC;AACH,CAAC;AAED,6DAA6D;AAC7D,MAAM,UAAU,qBAAqB,CACpC,OAAgC;IAEhC,OAAO,MAAM,cAAc;QAC1B,MAAM,CAAC,WAAW,GAAG,iBAAiB,CAAC;QACvC,MAAM,CAAC,WAAW,GACjB,2DAA2D,CAAC;QAC7D,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAKrD,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC;YAClE,OAAO,CAAC,GAAG,CACV,MAAM,CAAC,MAAM;gBACZ,CAAC,CAAC,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACrC,CAAC,CAAC,kBAAkB,CACrB,CAAC;YACF,MAAM,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC;KACD,CAAC;AACH,CAAC;AAED,0FAA0F;AAC1F,MAAM,UAAU,sBAAsB,CACrC,OAAgC;IAEhC,OAAO,MAAM,eAAe;QAC3B,MAAM,CAAC,WAAW,GAAG,kBAAkB,CAAC;QACxC,MAAM,CAAC,WAAW,GAAG,oCAAoC,CAAC;QAC1D,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QAEpC,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;YAC3C,OAAO,CAAC,GAAG,CACV,OAAO,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,4BAA4B,CACjE,CAAC;QACH,CAAC;KACD,CAAC;AACH,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,qBAAqB,CACpC,OAAgC;IAEhC,OAAO,MAAM,cAAc;QAC1B,MAAM,CAAC,WAAW,GAAG,iBAAiB,CAAC;QACvC,MAAM,CAAC,WAAW,GACjB,+EAA+E,CAAC;QACjF,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,EAAE,gBAAgB,EAAE,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAMzE,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC;gBACvC,KAAK,EAAE,IAAI,CAAC,KAAK,KAAK,IAAI;gBAC1B,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU;aACjD,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CACV,QAAQ,CAAC,MAAM;gBACd,CAAC,CAAC,+BAA+B,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBACtD,CAAC,CAAC,2CAA2C,CAC9C,CAAC;YACF,MAAM,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC;KACD,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,uBAAuB,CACtC,OAAgC;IAEhC,OAAO,MAAM,gBAAgB;QAC5B,MAAM,CAAC,WAAW,GAAG,mBAAmB,CAAC;QACzC,MAAM,CAAC,WAAW,GACjB,6EAA6E,CAAC;QAC/E,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,EAAE,oBAAoB,EAAE,CAAC,CAAC;QAKrD,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;gBACjD,KAAK,EAAE,IAAI,CAAC,KAAK,KAAK,IAAI;aAC1B,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,gBAAgB,MAAM,CAAC,MAAM,aAAa,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YACzE,MAAM,gBAAgB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QACvC,CAAC;KACD,CAAC;AACH,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,aAAa,CAC5B,OAAgC;IAEhC,OAAO,MAAM,MAAM;QAClB,MAAM,CAAC,WAAW,GAAG,SAAS,CAAC;QAC/B,MAAM,CAAC,WAAW,GACjB,iFAAiF,CAAC;QACnF,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;QACpC,MAAM,CAAC,KAAK,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC;QAI7B,KAAK,CAAC,GAAG;YACR,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACtC,IAAI,CAAC,MAAM;gBAAE,OAAO;YACpB,MAAM,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;QACnC,CAAC;KACD,CAAC;AACH,CAAC;AAED,8DAA8D;AAC9D,MAAM,cAAc,GAAG;;;;;;;;;;;;;CAatB,CAAC;AAEF;;;;;;GAMG;AACH,MAAM,UAAU,oBAAoB,CACnC,OAAgC;IAEhC,OAAO,MAAM,aAAa;QACzB,MAAM,CAAC,WAAW,GAAG,gBAAgB,CAAC;QACtC,MAAM,CAAC,WAAW,GAAG,2CAA2C,CAAC;QACjE,0CAA0C;QAC1C,MAAM,CAAC,OAAO,GAAG,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,WAAW,EAAE,qBAAqB,EAAE,CAAC,CAAC,CAAC;QAIzE,KAAK,CAAC,GAAG;YACR,qEAAqE;YACrE,mCAAmC;YACnC,IAAI,CAAC;gBACJ,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,mBAAmB,EAAE,WAAW,CAAC,CAAC;YAC7D,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO,CAAC,KAAK,CAAC,mCAAmC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC9D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,OAAO;YACR,CAAC;YACD,MAAM,QAAQ,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,IAAI,CAAC,IAAI,KAAK,CAAC;YACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;YAC5D,MAAM,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YAC5D,MAAM,GAAG,CAAC,SAAS,CAAC,QAAQ,EAAE,cAAc,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;YAC9D,OAAO,CAAC,GAAG,CAAC,WAAW,QAAQ,EAAE,CAAC,CAAC;QACpC,CAAC;KACD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,SAAS,GAAG,GAAG,EAAE,CACtB,IAAI,CAAC,OAAO,EAAE,SAAS,EAAE;IACxB,WAAW,EAAE,+BAA+B;CAC5C,CAAC,CAAC;AAEJ,MAAM,gBAAgB,GAAG,GAAG,EAAE,CAC7B,IAAI,CAAC,YAAY,EAAE,QAAQ,EAAE;IAC5B,WAAW,EAAE,+CAA+C;CAC5D,CAAC,CAAC;AAEJ,MAAM,oBAAoB,GAAG,GAAG,EAAE,CACjC,IAAI,CAAC,kBAAkB,EAAE,SAAS,EAAE;IACnC,WAAW,EAAE,8CAA8C;CAC3D,CAAC,CAAC;AAEJ;;;;GAIG;AACH,KAAK,UAAU,gBAAgB,CAC9B,OAAgC,EAChC,OAAuC;IAEvC,MAAM,GAAG,GAAG,OAAO,CAAC,gBAAgB,CAAC;IACrC,4EAA4E;IAC5E,yEAAyE;IACzE,IAAI,CAAC,GAAG,EAAE,UAAU,IAAI,GAAG,CAAC,OAAO,KAAK,KAAK;QAAE,OAAO;IACtD,IAAI,OAAO,CAAC,gBAAgB,KAAK,IAAI;QAAE,OAAO;IAC9C,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE;QAAE,OAAO;IAChB,MAAM,CAAC,GAAG,MAAM,kBAAkB,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;IAC5C,OAAO,CAAC,GAAG,CACV,eAAe,GAAG,CAAC,UAAU,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,GAAG,CACjE,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAS,cAAc,CACtB,KAAyB;IAEzB,6EAA6E;IAC7E,gDAAgD;IAChD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAClE,CAAC"}

package/dist/console/schemaCheckCommand.d.ts

@@ -1,26 +1,22 @@
 /**
  * `atlas:check` console command — the Ream-idiomatic CLI for schema
- * verification. Ream commands are plain `{ name, description, run }` objects
- * registered in `reamrc.commands` and dispatched by the console kernel
- * (`new Ignitor(...).console().handle(argv)`).
+ * verification. Ream commands are classes carrying their name, description and
+ * inputs as statics; the console kernel discovers them in `commands/` or reads
+ * them from `reamrc.commands`.
  *
  * Stays framework-agnostic: resolves the live connection + dialect from atlas's
  * OWN service locators (`getDb` / `getAtlasDialect`), never importing
- * `@c9up/ream`. The {@link AtlasCommand} shape structurally matches Ream's
- * `Command` interface, so the console kernel accepts it without a type
- * dependency in either direction.
+ * `@c9up/ream`. The {@link AtlasCommandClass} shape structurally matches Ream's
+ * command contract, so the console kernel accepts it without a type dependency
+ * in either direction.
  */
+import { type AtlasCommandClass } from "./contract.js";
 type Constructor = new (...args: unknown[]) => unknown;
-/** Structural match of Ream's console `Command` (no `@c9up/ream` import). */
-export interface AtlasCommand {
-    name: string;
-    description: string;
-    run(args: string[], flags: Record<string, string | boolean>): Promise<void>;
-}
+export type { AtlasCommandClass } from "./contract.js";
 /**
  * Build the `atlas:check` command for the given models. Register it in
  * `reamrc.commands` (atlas has no global entity registry — list your models,
- * as in Lucid). Run it via the console kernel; `--warn` reports drift without a
+ * as in Lucid). Run it as `ream atlas:check`; `--warn` reports drift without a
  * non-zero exit (useful for an advisory CI step).
  *
  * @example
@@ -29,9 +25,7 @@ export interface AtlasCommand {
  *   import { User } from '#models/user'
  *   export default schemaCheckCommand([User])
  *
- *   // reamrc.ts → commands: [() => import('./commands/atlas-check.js')]
- *   // run:  <console-entry> atlas:check
+ *   // run:  ream atlas:check --warn
  */
-export declare function schemaCheckCommand(entities: readonly Constructor[]): AtlasCommand;
-export {};
+export declare function schemaCheckCommand(entities: readonly Constructor[]): AtlasCommandClass;
 //# sourceMappingURL=schemaCheckCommand.d.ts.map

package/dist/console/schemaCheckCommand.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schemaCheckCommand.d.ts","sourceRoot":"","sources":["../../src/console/schemaCheckCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAMH,KAAK,WAAW,GAAG,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;AAEvD,6EAA6E;AAC7E,MAAM,WAAW,YAAY;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5E;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,kBAAkB,CACjC,QAAQ,EAAE,SAAS,WAAW,EAAE,GAC9B,YAAY,CAkBd"}
+{"version":3,"file":"schemaCheckCommand.d.ts","sourceRoot":"","sources":["../../src/console/schemaCheckCommand.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAKH,OAAO,EAAE,KAAK,iBAAiB,EAAQ,MAAM,eAAe,CAAC;AAE7D,KAAK,WAAW,GAAG,KAAK,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;AAEvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,kBAAkB,CACjC,QAAQ,EAAE,SAAS,WAAW,EAAE,GAC9B,iBAAiB,CA2BnB"}

package/dist/console/schemaCheckCommand.js

@@ -1,22 +1,23 @@
 /**
  * `atlas:check` console command — the Ream-idiomatic CLI for schema
- * verification. Ream commands are plain `{ name, description, run }` objects
- * registered in `reamrc.commands` and dispatched by the console kernel
- * (`new Ignitor(...).console().handle(argv)`).
+ * verification. Ream commands are classes carrying their name, description and
+ * inputs as statics; the console kernel discovers them in `commands/` or reads
+ * them from `reamrc.commands`.
  *
  * Stays framework-agnostic: resolves the live connection + dialect from atlas's
  * OWN service locators (`getDb` / `getAtlasDialect`), never importing
- * `@c9up/ream`. The {@link AtlasCommand} shape structurally matches Ream's
- * `Command` interface, so the console kernel accepts it without a type
- * dependency in either direction.
+ * `@c9up/ream`. The {@link AtlasCommandClass} shape structurally matches Ream's
+ * command contract, so the console kernel accepts it without a type dependency
+ * in either direction.
  */
 import { getAtlasDialect } from "../query/native.js";
 import { runSchemaCheck } from "../schema/SchemaCheck.js";
 import { getDb } from "../services/db.js";
+import { flag } from "./contract.js";
 /**
  * Build the `atlas:check` command for the given models. Register it in
  * `reamrc.commands` (atlas has no global entity registry — list your models,
- * as in Lucid). Run it via the console kernel; `--warn` reports drift without a
+ * as in Lucid). Run it as `ream atlas:check`; `--warn` reports drift without a
  * non-zero exit (useful for an advisory CI step).
  *
  * @example
@@ -25,14 +26,19 @@ import { getDb } from "../services/db.js";
  *   import { User } from '#models/user'
  *   export default schemaCheckCommand([User])
  *
- *   // reamrc.ts → commands: [() => import('./commands/atlas-check.js')]
- *   // run:  <console-entry> atlas:check
+ *   // run:  ream atlas:check --warn
  */
 export function schemaCheckCommand(entities) {
-    return {
-        name: "atlas:check",
-        description: "Verify models match the live database schema",
-        async run(_args, flags) {
+    return class SchemaCheck {
+        static commandName = "atlas:check";
+        static description = "Verify models match the live database schema";
+        static options = { startApp: true };
+        static flags = [
+            flag("warn", "boolean", {
+                description: "Report drift without failing (exit 0)",
+            }),
+        ];
+        async run() {
             const db = getDb();
             if (!db) {
                 console.error("[atlas:check] no database connection — is AtlasProvider registered?");
@@ -41,9 +47,9 @@ export function schemaCheckCommand(entities) {
             }
             const code = await runSchemaCheck(entities, db, getAtlasDialect());
             // `--warn` downgrades drift to advisory (exit 0); default fails CI.
-            if (code !== 0 && !flags.warn)
+            if (code !== 0 && !this.warn)
                 process.exitCode = code;
-        },
+        }
     };
 }
 //# sourceMappingURL=schemaCheckCommand.js.map