@ethlete/cli 3.0.0-next.16 → 3.0.0-next.18

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ethlete/cli
 
+## 3.0.0-next.18
+
+### Minor Changes
+
+- Add `et api ready --profile` to bring an API's data up to date from a snapshot or its seeds, plus `exec`, `doctor [--fix]`, `run --lock`, `snapshot save|restore` and `status`, with a machine-wide lock and state.
+
+## 3.0.0-next.17
+
+### Minor Changes
+
+- Add `et api seed` and `et api fixtures`, which copy `.ethlete/seeds/<api>/` into the API container and run the seeds its `seeds.json` names. A clone now gitignores only its own `/.ethlete/<api>/`.
+
 ## 3.0.0-next.16
 
 ### Major Changes

package/README.md

@@ -104,10 +104,18 @@ yarn et api clone hub           # clone the API into .ethlete/hub
 yarn et api clear hub           # remove that clone again
 yarn et api clear --all         # remove every managed clone
 yarn et api setup hub           # run the API's own setupCommand, which writes its .env
+yarn et api seed hub            # list the seeds in .ethlete/seeds/hub/seeds.json
+yarn et api seed hub demo,shop  # run two of them, in that order
+yarn et api fixtures hub demo   # load the fixtures, then run the demo seed
 ```
 
 Every command takes a comma-separated list of names, and acts on each API in turn.
 
+`seed` and `fixtures` read `.ethlete/seeds/<name>/seeds.json`, copy that folder into the API
+container at `$SEED_DIR`, and run the shell lines of each seed you name there. The folder is
+committed, so gitignore each managed checkout as `/.ethlete/<name>/`, never `.ethlete/` as a whole.
+An `exec` entry named `seed` or `fixtures` runs instead.
+
 `clone`, `checkout`, `pull`, `setup` and `clear` act on the checkout itself, so they work before the
 API has an `.env` and need no container engine. `pull` refuses to run on a checkout with uncommitted
 changes unless you pass `--force`. `--force` resets the branch to its remote and throws away local

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ethlete/cli",
-  "version": "3.0.0-next.16",
+  "version": "3.0.0-next.18",
   "license": "MIT",
   "type": "commonjs",
   "main": "./src/index.js",

package/src/lib/api/api-context.d.ts

@@ -0,0 +1,15 @@
+import { ApiDefinition } from './definition';
+export declare const definedEntries: (record: Record<string, string | undefined>) => Record<string, string>;
+/** The checkout and the machine-wide state directory of one API, or the checkout failure. */
+export declare const stateDirectoryOf: (options: {
+    root: string;
+    name: string;
+    api: ApiDefinition;
+    needs?: "compose" | "env";
+}) => ({
+    legacyConfigWarning?: string;
+} & import("./resolve-checkout").ApiCheckoutFailure) | {
+    ok: true;
+    checkout: import("./resolve-checkout").ApiCheckout;
+    directory: string;
+};

package/src/lib/api/api-context.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stateDirectoryOf = exports.definedEntries = void 0;
+const api_state_1 = require("./api-state");
+const resolve_checkout_1 = require("./resolve-checkout");
+const definedEntries = (record) => Object.fromEntries(Object.entries(record).filter(([, value]) => value !== undefined));
+exports.definedEntries = definedEntries;
+/** The checkout and the machine-wide state directory of one API, or the checkout failure. */
+const stateDirectoryOf = (options) => {
+    var _a, _b, _c;
+    const { api } = options;
+    const checkout = (0, resolve_checkout_1.resolveApiCheckout)(Object.assign(Object.assign({}, options), { needs: (_a = options.needs) !== null && _a !== void 0 ? _a : 'compose' }));
+    if (!checkout.ok)
+        return checkout;
+    const env = Object.assign(Object.assign({}, process.env), (0, exports.definedEntries)((_c = (_b = api.env) === null || _b === void 0 ? void 0 : _b.call(api)) !== null && _c !== void 0 ? _c : {}));
+    return {
+        ok: true,
+        checkout: checkout.checkout,
+        directory: (0, api_state_1.apiStateDirectory)({ project: (0, api_state_1.composeProjectName)({ composePath: checkout.checkout.composePath, env }) }),
+    };
+};
+exports.stateDirectoryOf = stateDirectoryOf;
+//# sourceMappingURL=api-context.js.map

package/src/lib/api/api-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-context.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/api-context.ts"],"names":[],"mappings":";;;AAAA,2CAAoE;AAEpE,yDAAwD;AAEjD,MAAM,cAAc,GAAG,CAAC,MAA0C,EAAE,EAAE,CAC3E,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAA2B,CAAC;AADrG,QAAA,cAAc,kBACuF;AAElH,6FAA6F;AACtF,MAAM,gBAAgB,GAAG,CAAC,OAKhC,EAAE,EAAE;;IACH,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC;IACxB,MAAM,QAAQ,GAAG,IAAA,qCAAkB,kCAAM,OAAO,KAAE,KAAK,EAAE,MAAA,OAAO,CAAC,KAAK,mCAAI,SAAS,IAAG,CAAC;IAEvF,IAAI,CAAC,QAAQ,CAAC,EAAE;QAAE,OAAO,QAAQ,CAAC;IAElC,MAAM,GAAG,mCAAQ,OAAO,CAAC,GAAG,GAAK,IAAA,sBAAc,EAAC,MAAA,MAAA,GAAG,CAAC,GAAG,mDAAI,mCAAI,EAAE,CAAC,CAAE,CAAC;IAErE,OAAO;QACL,EAAE,EAAE,IAAa;QACjB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,SAAS,EAAE,IAAA,6BAAiB,EAAC,EAAE,OAAO,EAAE,IAAA,8BAAkB,EAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;KACnH,CAAC;AACJ,CAAC,CAAC;AAlBW,QAAA,gBAAgB,oBAkB3B"}

package/src/lib/api/api-state.d.ts

@@ -0,0 +1,31 @@
+/** What `ready` last brought the API into. `dirty` means something changed the data since. */
+export type ApiState = {
+    profile: string | null;
+    fingerprint: string | null;
+    dirty: boolean;
+    updatedAt: string;
+};
+/**
+ * The compose project name the container engine gives this compose directory, resolved the way compose
+ * does: `COMPOSE_PROJECT_NAME` from the environment or the directory's `.env`, then the top-level
+ * `name:` of the compose file, then the directory name.
+ */
+export declare const composeProjectName: (options: {
+    composePath: string;
+    env?: NodeJS.ProcessEnv;
+}) => string;
+/** Machine-wide directory of one compose project's `state.json` and `lock.json`. */
+export declare const apiStateDirectory: (options: {
+    project: string;
+    env?: NodeJS.ProcessEnv;
+}) => string;
+/** The stored state, or `undefined` when there is none or it cannot be read. */
+export declare const readApiState: (directory: string) => ApiState | undefined;
+/** Replaces `state.json` in one rename, so a reader never sees half a file. */
+export declare const writeApiState: (options: {
+    directory: string;
+    state: Omit<ApiState, "updatedAt">;
+    now?: Date;
+}) => ApiState;
+/** Keeps the stored profile and fingerprint, so `status` can still say what the data was before. */
+export declare const markApiStateDirty: (directory: string, now?: Date) => ApiState;

package/src/lib/api/api-state.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.markApiStateDirty = exports.writeApiState = exports.readApiState = exports.apiStateDirectory = exports.composeProjectName = void 0;
+const crypto_1 = require("crypto");
+const fs_1 = require("fs");
+const os_1 = require("os");
+const path_1 = require("path");
+const COMPOSE_FILE_NAMES = ['compose.yaml', 'compose.yml', 'docker-compose.yaml', 'docker-compose.yml'];
+const normalizeProjectName = (name) => name.toLowerCase().replace(/[^a-z0-9_-]/g, '');
+const readText = (path) => ((0, fs_1.existsSync)(path) ? (0, fs_1.readFileSync)(path, 'utf8') : undefined);
+const literal = (value) => (value === undefined || value.includes('$') ? undefined : value);
+/**
+ * The compose project name the container engine gives this compose directory, resolved the way compose
+ * does: `COMPOSE_PROJECT_NAME` from the environment or the directory's `.env`, then the top-level
+ * `name:` of the compose file, then the directory name.
+ */
+const composeProjectName = (options) => {
+    var _a, _b, _c, _d;
+    const { composePath, env = process.env } = options;
+    const fromDotEnv = (_b = (_a = readText((0, path_1.join)(composePath, '.env'))) === null || _a === void 0 ? void 0 : _a.match(/^\s*COMPOSE_PROJECT_NAME\s*=\s*["']?([^"'\s#]+)/m)) === null || _b === void 0 ? void 0 : _b[1];
+    const composeFile = COMPOSE_FILE_NAMES.map((name) => (0, path_1.join)(composePath, name)).find((path) => (0, fs_1.existsSync)(path));
+    const fromComposeFile = composeFile ? (_d = (_c = readText(composeFile)) === null || _c === void 0 ? void 0 : _c.match(/^name:\s*["']?([^"'\s#]+)/m)) === null || _d === void 0 ? void 0 : _d[1] : undefined;
+    const name = [env['COMPOSE_PROJECT_NAME'], literal(fromDotEnv), literal(fromComposeFile)]
+        .map((candidate) => (candidate ? normalizeProjectName(candidate) : ''))
+        .find((candidate) => candidate !== '');
+    return name !== null && name !== void 0 ? name : normalizeProjectName((0, path_1.basename)(composePath));
+};
+exports.composeProjectName = composeProjectName;
+/** Machine-wide directory of one compose project's `state.json` and `lock.json`. */
+const apiStateDirectory = (options) => {
+    const { project, env = process.env } = options;
+    const stateHome = env['XDG_STATE_HOME'] || (0, path_1.join)((0, os_1.homedir)(), '.local/state');
+    return (0, path_1.join)(stateHome, 'ethlete', 'api', project);
+};
+exports.apiStateDirectory = apiStateDirectory;
+const statePath = (directory) => (0, path_1.join)(directory, 'state.json');
+/** The stored state, or `undefined` when there is none or it cannot be read. */
+const readApiState = (directory) => {
+    try {
+        const value = JSON.parse((0, fs_1.readFileSync)(statePath(directory), 'utf8'));
+        return {
+            profile: typeof value.profile === 'string' ? value.profile : null,
+            fingerprint: typeof value.fingerprint === 'string' ? value.fingerprint : null,
+            dirty: value.dirty === true,
+            updatedAt: typeof value.updatedAt === 'string' ? value.updatedAt : '',
+        };
+    }
+    catch (_a) {
+        return undefined;
+    }
+};
+exports.readApiState = readApiState;
+/** Replaces `state.json` in one rename, so a reader never sees half a file. */
+const writeApiState = (options) => {
+    const { directory, state, now = new Date() } = options;
+    const written = Object.assign(Object.assign({}, state), { updatedAt: now.toISOString() });
+    const temporary = (0, path_1.join)(directory, `state.json.${(0, crypto_1.randomUUID)()}.tmp`);
+    (0, fs_1.mkdirSync)(directory, { recursive: true });
+    try {
+        (0, fs_1.writeFileSync)(temporary, `${JSON.stringify(written, null, 2)}\n`, 'utf8');
+        (0, fs_1.renameSync)(temporary, statePath(directory));
+    }
+    finally {
+        (0, fs_1.rmSync)(temporary, { force: true });
+    }
+    return written;
+};
+exports.writeApiState = writeApiState;
+/** Keeps the stored profile and fingerprint, so `status` can still say what the data was before. */
+const markApiStateDirty = (directory, now = new Date()) => {
+    var _a, _b;
+    const previous = (0, exports.readApiState)(directory);
+    return (0, exports.writeApiState)({
+        directory,
+        state: { profile: (_a = previous === null || previous === void 0 ? void 0 : previous.profile) !== null && _a !== void 0 ? _a : null, fingerprint: (_b = previous === null || previous === void 0 ? void 0 : previous.fingerprint) !== null && _b !== void 0 ? _b : null, dirty: true },
+        now,
+    });
+};
+exports.markApiStateDirty = markApiStateDirty;
+//# sourceMappingURL=api-state.js.map

package/src/lib/api/api-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-state.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/api-state.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AACpC,2BAA4F;AAC5F,2BAA6B;AAC7B,+BAAsC;AAUtC,MAAM,kBAAkB,GAAG,CAAC,cAAc,EAAE,aAAa,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,CAAC;AAExG,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;AAE9F,MAAM,QAAQ,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAA,iBAAY,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;AAE/F,MAAM,OAAO,GAAG,CAAC,KAAyB,EAAE,EAAE,CAAC,CAAC,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAEhH;;;;GAIG;AACI,MAAM,kBAAkB,GAAG,CAAC,OAAyD,EAAE,EAAE;;IAC9F,MAAM,EAAE,WAAW,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC;IACnD,MAAM,UAAU,GAAG,MAAA,MAAA,QAAQ,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,MAAM,CAAC,CAAC,0CAAE,KAAK,CAC3D,kDAAkD,CACnD,0CAAG,CAAC,CAAC,CAAC;IACP,MAAM,WAAW,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,eAAU,EAAC,IAAI,CAAC,CAAC,CAAC;IAC/G,MAAM,eAAe,GAAG,WAAW,CAAC,CAAC,CAAC,MAAA,MAAA,QAAQ,CAAC,WAAW,CAAC,0CAAE,KAAK,CAAC,4BAA4B,CAAC,0CAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAClH,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,sBAAsB,CAAC,EAAE,OAAO,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;SACtF,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;SACtE,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,KAAK,EAAE,CAAC,CAAC;IAEzC,OAAO,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,oBAAoB,CAAC,IAAA,eAAQ,EAAC,WAAW,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC;AAZW,QAAA,kBAAkB,sBAY7B;AAEF,oFAAoF;AAC7E,MAAM,iBAAiB,GAAG,CAAC,OAAqD,EAAE,EAAE;IACzF,MAAM,EAAE,OAAO,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC;IAC/C,MAAM,SAAS,GAAG,GAAG,CAAC,gBAAgB,CAAC,IAAI,IAAA,WAAI,EAAC,IAAA,YAAO,GAAE,EAAE,cAAc,CAAC,CAAC;IAE3E,OAAO,IAAA,WAAI,EAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;AACpD,CAAC,CAAC;AALW,QAAA,iBAAiB,qBAK5B;AAEF,MAAM,SAAS,GAAG,CAAC,SAAiB,EAAE,EAAE,CAAC,IAAA,WAAI,EAAC,SAAS,EAAE,YAAY,CAAC,CAAC;AAEvE,gFAAgF;AACzE,MAAM,YAAY,GAAG,CAAC,SAAiB,EAAwB,EAAE;IACtE,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,SAAS,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC,CAAsB,CAAC;QAE1F,OAAO;YACL,OAAO,EAAE,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;YACjE,WAAW,EAAE,OAAO,KAAK,CAAC,WAAW,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI;YAC7E,KAAK,EAAE,KAAK,CAAC,KAAK,KAAK,IAAI;YAC3B,SAAS,EAAE,OAAO,KAAK,CAAC,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE;SACtE,CAAC;IACJ,CAAC;IAAC,WAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC,CAAC;AAbW,QAAA,YAAY,gBAavB;AAEF,+EAA+E;AACxE,MAAM,aAAa,GAAG,CAAC,OAA8E,EAAE,EAAE;IAC9G,MAAM,EAAE,SAAS,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE,EAAE,GAAG,OAAO,CAAC;IACvD,MAAM,OAAO,mCAAkB,KAAK,KAAE,SAAS,EAAE,GAAG,CAAC,WAAW,EAAE,GAAE,CAAC;IACrE,MAAM,SAAS,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,cAAc,IAAA,mBAAU,GAAE,MAAM,CAAC,CAAC;IAEpE,IAAA,cAAS,EAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAE1C,IAAI,CAAC;QACH,IAAA,kBAAa,EAAC,SAAS,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC1E,IAAA,eAAU,EAAC,SAAS,EAAE,SAAS,CAAC,SAAS,CAAC,CAAC,CAAC;IAC9C,CAAC;YAAS,CAAC;QACT,IAAA,WAAM,EAAC,SAAS,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAfW,QAAA,aAAa,iBAexB;AAEF,oGAAoG;AAC7F,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAE,GAAG,GAAG,IAAI,IAAI,EAAE,EAAE,EAAE;;IACvE,MAAM,QAAQ,GAAG,IAAA,oBAAY,EAAC,SAAS,CAAC,CAAC;IAEzC,OAAO,IAAA,qBAAa,EAAC;QACnB,SAAS;QACT,KAAK,EAAE,EAAE,OAAO,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,OAAO,mCAAI,IAAI,EAAE,WAAW,EAAE,MAAA,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,WAAW,mCAAI,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE;QACtG,GAAG;KACJ,CAAC,CAAC;AACL,CAAC,CAAC;AARW,QAAA,iBAAiB,qBAQ5B"}

package/src/lib/api/definition.d.ts

@@ -24,9 +24,45 @@ export type ApiDefinition = {
     env?: () => Record<string, string | undefined>;
     /** Named commands run in `execService`, for example `{ install: ['composer', 'install'] }`. */
     exec?: Record<string, string[]>;
+    /** Ordered preconditions checked by `doctor`. A later check may rely on an earlier one. */
+    checks?: ApiCheck[];
+    /** Named states `ready` and `snapshot` work with. */
+    profiles?: Record<string, ApiProfile>;
+    /** Migrations folder relative to the API checkout root. Its contents are part of the state fingerprint. */
+    migrationsDir?: string;
+};
+/** One precondition of the API's local setup, run in order by `doctor`. */
+export type ApiCheck = {
+    /** Unique label printed in the `doctor` report. */
+    name: string;
+    /** One shell line that exits 0 when the check passes. */
+    check: string;
+    /** One shell line that repairs a failed check, run by `doctor --fix`. */
+    fix?: string;
+    /** Service the lines run in. Defaults to `execService`. */
+    service?: string;
+    /** Run on the host in `composeDir` with the API's `env` instead of in a container. */
+    host?: boolean;
+};
+/** A named state the API can be brought into. */
+export type ApiProfile = {
+    /** Seed names from `seeds.json` run in order, where `fixtures` stands for the fixtures list. */
+    seeds: string[];
+    /** Url that must answer with `expect` (default 200) before the profile counts as ready. */
+    health?: {
+        url: string;
+        expect?: number;
+    };
+    /** How to dump and restore the databases: `save` writes to stdout, `restore` reads stdin, both see `$DATABASES`. */
+    snapshot?: {
+        service: string;
+        databases: string[];
+        save: string;
+        restore: string;
+    };
 };
 export type ApiDefinitions = Record<string, ApiDefinition>;
-export declare const BUILT_IN_API_COMMANDS: readonly ["up", "down", "logs", "shell", "clone", "clear", "checkout", "pull", "setup"];
+export declare const BUILT_IN_API_COMMANDS: readonly ["up", "down", "logs", "shell", "clone", "clear", "checkout", "pull", "setup", "exec", "doctor", "run", "ready", "snapshot", "status"];
 /** These act on the checkout itself, so they run before `setupCommand` and need no container engine. */
 export declare const GIT_API_COMMANDS: string[];
 /** Whether an exec entry downloads dependencies, which is the only failure the private-dependency hint explains. */

package/src/lib/api/definition.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.apiCommandNames = exports.dependencyInstallCommandName = exports.installsDependencies = exports.GIT_API_COMMANDS = exports.BUILT_IN_API_COMMANDS = void 0;
+const seeds_1 = require("./seeds");
 exports.BUILT_IN_API_COMMANDS = [
     'up',
     'down',
@@ -11,6 +12,12 @@ exports.BUILT_IN_API_COMMANDS = [
     'checkout',
     'pull',
     'setup',
+    'exec',
+    'doctor',
+    'run',
+    'ready',
+    'snapshot',
+    'status',
 ];
 /** These act on the checkout itself, so they run before `setupCommand` and need no container engine. */
 exports.GIT_API_COMMANDS = ['clone', 'checkout', 'pull'];
@@ -25,8 +32,11 @@ exports.dependencyInstallCommandName = dependencyInstallCommandName;
 const apiCommandNames = (api) => {
     var _a;
     return [
-        ...exports.BUILT_IN_API_COMMANDS.filter((command) => command !== 'setup' || api.setupCommand),
-        ...Object.keys((_a = api.exec) !== null && _a !== void 0 ? _a : {}),
+        ...new Set([
+            ...exports.BUILT_IN_API_COMMANDS.filter((command) => command !== 'setup' || api.setupCommand),
+            ...seeds_1.SEED_API_COMMANDS,
+            ...Object.keys((_a = api.exec) !== null && _a !== void 0 ? _a : {}),
+        ]),
     ];
 };
 exports.apiCommandNames = apiCommandNames;

package/src/lib/api/definition.js.map

@@ -1 +1 @@
-{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/definition.ts"],"names":[],"mappings":";;;AA8Ba,QAAA,qBAAqB,GAAG;IACnC,IAAI;IACJ,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,UAAU;IACV,MAAM;IACN,OAAO;CACC,CAAC;AAEX,wGAAwG;AAC3F,QAAA,gBAAgB,GAAa,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAExE,MAAM,qBAAqB,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAElG,oHAAoH;AAC7G,MAAM,oBAAoB,GAAG,CAAC,WAA8B,EAAE,EAAE,WACrE,OAAA,qBAAqB,CAAC,QAAQ,CAAC,MAAA,WAAW,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC;AAD1C,QAAA,oBAAoB,wBACsB;AAEvD,gGAAgG;AACzF,MAAM,4BAA4B,GAAG,CAAC,GAAkB,EAAE,EAAE,WACjE,OAAA,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,eAAC,OAAA,IAAA,4BAAoB,EAAC,MAAA,MAAA,GAAG,CAAC,IAAI,0CAAG,IAAI,CAAC,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC,CAAA,EAAA,CAAC;AAD9E,QAAA,4BAA4B,gCACkD;AAE3F,+GAA+G;AACxG,MAAM,eAAe,GAAG,CAAC,GAAkB,EAAE,EAAE;;IAAC,OAAA;QACrD,GAAG,6BAAqB,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,OAAO,IAAI,GAAG,CAAC,YAAY,CAAC;QACrF,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC;KAC/B,CAAA;CAAA,CAAC;AAHW,QAAA,eAAe,mBAG1B"}
+{"version":3,"file":"definition.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/definition.ts"],"names":[],"mappings":";;;AAAA,mCAA4C;AA8D/B,QAAA,qBAAqB,GAAG;IACnC,IAAI;IACJ,MAAM;IACN,MAAM;IACN,OAAO;IACP,OAAO;IACP,OAAO;IACP,UAAU;IACV,MAAM;IACN,OAAO;IACP,MAAM;IACN,QAAQ;IACR,KAAK;IACL,OAAO;IACP,UAAU;IACV,QAAQ;CACA,CAAC;AAEX,wGAAwG;AAC3F,QAAA,gBAAgB,GAAa,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;AAExE,MAAM,qBAAqB,GAAG,CAAC,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;AAElG,oHAAoH;AAC7G,MAAM,oBAAoB,GAAG,CAAC,WAA8B,EAAE,EAAE,WACrE,OAAA,qBAAqB,CAAC,QAAQ,CAAC,MAAA,WAAW,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC;AAD1C,QAAA,oBAAoB,wBACsB;AAEvD,gGAAgG;AACzF,MAAM,4BAA4B,GAAG,CAAC,GAAkB,EAAE,EAAE,WACjE,OAAA,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,eAAC,OAAA,IAAA,4BAAoB,EAAC,MAAA,MAAA,GAAG,CAAC,IAAI,0CAAG,IAAI,CAAC,mCAAI,EAAE,CAAC,CAAA,EAAA,CAAC,CAAA,EAAA,CAAC;AAD9E,QAAA,4BAA4B,gCACkD;AAE3F,+GAA+G;AACxG,MAAM,eAAe,GAAG,CAAC,GAAkB,EAAE,EAAE;;IAAC,OAAA;QACrD,GAAG,IAAI,GAAG,CAAC;YACT,GAAG,6BAAqB,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,OAAO,IAAI,GAAG,CAAC,YAAY,CAAC;YACrF,GAAG,yBAAiB;YACpB,GAAG,MAAM,CAAC,IAAI,CAAC,MAAA,GAAG,CAAC,IAAI,mCAAI,EAAE,CAAC;SAC/B,CAAC;KACH,CAAA;CAAA,CAAC;AANW,QAAA,eAAe,mBAM1B"}

package/src/lib/api/doctor.d.ts

@@ -0,0 +1,16 @@
+import { ApiDefinition } from './definition';
+import { ComposeTool } from './compose';
+export type RunDoctorOptions = {
+    name: string;
+    api: ApiDefinition;
+    tool: ComposeTool;
+    /** The compose directory of the API checkout. */
+    cwd: string;
+    env: NodeJS.ProcessEnv;
+    invocation: string;
+    fix: boolean;
+};
+/** Runs the API's checks in order, repairing failures when `fix` is set. Stops at the first failure it cannot repair. */
+export declare const runDoctor: ({ name, api, tool, cwd, env, invocation, fix }: RunDoctorOptions) => {
+    ok: boolean;
+};

package/src/lib/api/doctor.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runDoctor = void 0;
+const child_process_1 = require("child_process");
+const STDERR_TAIL_LINES = 5;
+const NOT_RUNNING = /is not running|not running|no such container|no container|can only create exec sessions/i;
+/** Runs the API's checks in order, repairing failures when `fix` is set. Stops at the first failure it cannot repair. */
+const runDoctor = ({ name, api, tool, cwd, env, invocation, fix }) => {
+    var _a, _b;
+    const checks = (_a = api.checks) !== null && _a !== void 0 ? _a : [];
+    if (checks.length === 0) {
+        console.log(`The ${name} API declares no checks.`);
+        return { ok: true };
+    }
+    const [binary, ...composePrefix] = tool.compose;
+    const run = ({ check, line, stream }) => {
+        var _a, _b;
+        const [command, args] = check.host
+            ? ['sh', ['-c', line]]
+            : [binary, [...composePrefix, 'exec', '-T', (_a = check.service) !== null && _a !== void 0 ? _a : api.execService, 'sh', '-c', line]];
+        const result = (0, child_process_1.spawnSync)(command, args, Object.assign({ cwd,
+            env }, (stream ? { stdio: 'inherit' } : { encoding: 'utf8', maxBuffer: Infinity })));
+        const stderr = stream ? '' : `${(_b = result.stderr) !== null && _b !== void 0 ? _b : ''}`.trim();
+        return { ok: !result.error && result.status === 0, stderr: result.error ? result.error.message : stderr };
+    };
+    const printFailure = (stderr) => {
+        const tail = stderr
+            .split('\n')
+            .filter((line) => line !== '')
+            .slice(-STDERR_TAIL_LINES);
+        for (const line of tail)
+            console.log(`    ${line}`);
+    };
+    let failed = false;
+    for (const check of checks) {
+        const first = run({ check, line: check.check, stream: false });
+        if (first.ok) {
+            console.log(`ok          ${check.name}`);
+            continue;
+        }
+        if (!check.host && NOT_RUNNING.test(first.stderr)) {
+            console.log(`FAIL        ${check.name}`);
+            console.error(`\nThe ${(_b = check.service) !== null && _b !== void 0 ? _b : api.execService} service is not running. Start it with: ${invocation} up ${name}`);
+            return { ok: false };
+        }
+        if (!fix || check.fix === undefined) {
+            console.log(`FAIL        ${check.name}`);
+            printFailure(first.stderr);
+            if (fix)
+                return { ok: false };
+            failed = true;
+            continue;
+        }
+        console.log(`Fixing ${check.name}: ${check.fix}`);
+        const fixed = run({ check, line: check.fix, stream: true });
+        if (!fixed.ok) {
+            console.log(`fix failed  ${check.name}`);
+            return { ok: false };
+        }
+        const again = run({ check, line: check.check, stream: false });
+        if (!again.ok) {
+            console.log(`FAIL        ${check.name} (still failing after the fix)`);
+            printFailure(again.stderr);
+            return { ok: false };
+        }
+        console.log(`fixed       ${check.name}`);
+    }
+    return { ok: !failed };
+};
+exports.runDoctor = runDoctor;
+//# sourceMappingURL=doctor.js.map

package/src/lib/api/doctor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doctor.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/doctor.ts"],"names":[],"mappings":";;;AAAA,iDAA0C;AAI1C,MAAM,iBAAiB,GAAG,CAAC,CAAC;AAE5B,MAAM,WAAW,GAAG,0FAA0F,CAAC;AAa/G,yHAAyH;AAClH,MAAM,SAAS,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAoB,EAAmB,EAAE;;IAC7G,MAAM,MAAM,GAAG,MAAA,GAAG,CAAC,MAAM,mCAAI,EAAE,CAAC;IAEhC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACxB,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,0BAA0B,CAAC,CAAC;QAEnD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC;IACtB,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,GAAG,aAAa,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;IAEhD,MAAM,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAsD,EAAE,EAAE;;QAC1F,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI;YAChC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,aAAa,EAAE,MAAM,EAAE,IAAI,EAAE,MAAA,KAAK,CAAC,OAAO,mCAAI,GAAG,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;QAEnG,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,OAAiB,EAAE,IAAgB,kBAC1D,GAAG;YACH,GAAG,IACA,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAkB,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAe,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EAChG,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;QAE7D,OAAO,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAC5G,CAAC,CAAC;IAEF,MAAM,YAAY,GAAG,CAAC,MAAc,EAAE,EAAE;QACtC,MAAM,IAAI,GAAG,MAAM;aAChB,KAAK,CAAC,IAAI,CAAC;aACX,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC;aAC7B,KAAK,CAAC,CAAC,iBAAiB,CAAC,CAAC;QAE7B,KAAK,MAAM,IAAI,IAAI,IAAI;YAAE,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC,CAAC;IAEF,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,MAAM,KAAK,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAE/D,IAAI,KAAK,CAAC,EAAE,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACzC,SAAS;QACX,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACzC,OAAO,CAAC,KAAK,CACX,SAAS,MAAA,KAAK,CAAC,OAAO,mCAAI,GAAG,CAAC,WAAW,2CAA2C,UAAU,OAAO,IAAI,EAAE,CAC5G,CAAC;YAEF,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QACvB,CAAC;QAED,IAAI,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YACpC,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YACzC,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE3B,IAAI,GAAG;gBAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;YAE9B,MAAM,GAAG,IAAI,CAAC;YACd,SAAS;QACX,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,UAAU,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;QAElD,MAAM,KAAK,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QAE5D,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;YACd,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;YAEzC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QACvB,CAAC;QAED,MAAM,KAAK,GAAG,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;QAE/D,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC;YACd,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,CAAC,IAAI,gCAAgC,CAAC,CAAC;YACvE,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAE3B,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC;QACvB,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,CAAC,MAAM,EAAE,CAAC;AACzB,CAAC,CAAC;AAvFW,QAAA,SAAS,aAuFpB"}

package/src/lib/api/fingerprint.d.ts

@@ -0,0 +1,18 @@
+export declare const NO_GIT = "no-git";
+/** The major version of this CLI, so a change to what `ready` does invalidates every snapshot. */
+export declare const cliMajorVersion: () => string;
+/**
+ * A 12 character hash of everything a profile's data is built from: the API checkout's commit, its
+ * migrations, the repo's seed files, the profile's seed list, `ethlete.apis.js` and the CLI major version.
+ */
+export declare const fingerprintApi: (options: {
+    /** The repo root that holds `ethlete.apis.js` and `.ethlete/seeds`. */
+    root: string;
+    name: string;
+    /** The API checkout root, not its compose directory. */
+    repoPath: string;
+    migrationsDir?: string;
+    seeds: readonly string[];
+    cliMajor?: string;
+    head?: (repoPath: string) => string | undefined;
+}) => string;

package/src/lib/api/fingerprint.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fingerprintApi = exports.cliMajorVersion = exports.NO_GIT = void 0;
+const crypto_1 = require("crypto");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const load_definitions_1 = require("./load-definitions");
+const git_1 = require("./git");
+const seeds_1 = require("./seeds");
+exports.NO_GIT = 'no-git';
+const FINGERPRINT_LENGTH = 12;
+/** The major version of this CLI, so a change to what `ready` does invalidates every snapshot. */
+const cliMajorVersion = () => {
+    var _a, _b;
+    const manifest = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(__dirname, '..', '..', '..', 'package.json'), 'utf8'));
+    return (_b = (_a = manifest.version) === null || _a === void 0 ? void 0 : _a.split('.')[0]) !== null && _b !== void 0 ? _b : '0';
+};
+exports.cliMajorVersion = cliMajorVersion;
+const filesUnder = (directory) => {
+    if (!(0, fs_1.existsSync)(directory))
+        return [];
+    const walk = (relative) => (0, fs_1.readdirSync)((0, path_1.join)(directory, relative))
+        .sort()
+        .flatMap((entry) => {
+        const name = relative === '' ? entry : `${relative}/${entry}`;
+        const stats = (0, fs_1.statSync)((0, path_1.join)(directory, name));
+        return stats.isDirectory() ? walk(name) : stats.isFile() ? [name] : [];
+    });
+    return walk('');
+};
+/**
+ * A 12 character hash of everything a profile's data is built from: the API checkout's commit, its
+ * migrations, the repo's seed files, the profile's seed list, `ethlete.apis.js` and the CLI major version.
+ */
+const fingerprintApi = (options) => {
+    var _a;
+    const { root, name, repoPath, migrationsDir, seeds, cliMajor = (0, exports.cliMajorVersion)(), head = git_1.headCommit } = options;
+    const hash = (0, crypto_1.createHash)('sha256');
+    const add = (label, value) => {
+        hash.update(`${label}\0${value.length}\0`);
+        hash.update(value);
+        hash.update('\0');
+    };
+    const addFiles = (label, directory) => {
+        for (const file of filesUnder(directory)) {
+            add(`${label}:name`, file);
+            add(`${label}:content`, (0, fs_1.readFileSync)((0, path_1.join)(directory, file)));
+        }
+    };
+    add('head', (_a = head(repoPath)) !== null && _a !== void 0 ? _a : exports.NO_GIT);
+    if (migrationsDir !== undefined)
+        addFiles('migrations', (0, path_1.join)(repoPath, migrationsDir));
+    addFiles('seeds', (0, seeds_1.seedDirectory)(root, name));
+    add('profile-seeds', JSON.stringify(seeds));
+    for (const fileName of load_definitions_1.API_DEFINITIONS_FILE_NAMES) {
+        if ((0, fs_1.existsSync)((0, path_1.join)(root, fileName)))
+            add(`definitions:${fileName}`, (0, fs_1.readFileSync)((0, path_1.join)(root, fileName)));
+    }
+    add('cli', cliMajor);
+    return hash.digest('hex').slice(0, FINGERPRINT_LENGTH);
+};
+exports.fingerprintApi = fingerprintApi;
+//# sourceMappingURL=fingerprint.js.map

package/src/lib/api/fingerprint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fingerprint.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/fingerprint.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AACpC,2BAAqE;AACrE,+BAA4B;AAC5B,yDAAgE;AAChE,+BAAmC;AACnC,mCAAwC;AAE3B,QAAA,MAAM,GAAG,QAAQ,CAAC;AAE/B,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAE9B,kGAAkG;AAC3F,MAAM,eAAe,GAAG,GAAG,EAAE;;IAClC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CAElG,CAAC;IAEF,OAAO,MAAA,MAAA,QAAQ,CAAC,OAAO,0CAAE,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,mCAAI,GAAG,CAAC;AAChD,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B;AAEF,MAAM,UAAU,GAAG,CAAC,SAAiB,EAAY,EAAE;IACjD,IAAI,CAAC,IAAA,eAAU,EAAC,SAAS,CAAC;QAAE,OAAO,EAAE,CAAC;IAEtC,MAAM,IAAI,GAAG,CAAC,QAAgB,EAAY,EAAE,CAC1C,IAAA,gBAAW,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;SACnC,IAAI,EAAE;SACN,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QACjB,MAAM,IAAI,GAAG,QAAQ,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,IAAI,KAAK,EAAE,CAAC;QAC9D,MAAM,KAAK,GAAG,IAAA,aAAQ,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC;QAE9C,OAAO,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACzE,CAAC,CAAC,CAAC;IAEP,OAAO,IAAI,CAAC,EAAE,CAAC,CAAC;AAClB,CAAC,CAAC;AAEF;;;GAGG;AACI,MAAM,cAAc,GAAG,CAAC,OAU9B,EAAE,EAAE;;IACH,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ,GAAG,IAAA,uBAAe,GAAE,EAAE,IAAI,GAAG,gBAAU,EAAE,GAAG,OAAO,CAAC;IAChH,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,QAAQ,CAAC,CAAC;IAClC,MAAM,GAAG,GAAG,CAAC,KAAa,EAAE,KAAsB,EAAE,EAAE;QACpD,IAAI,CAAC,MAAM,CAAC,GAAG,KAAK,KAAK,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACnB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACpB,CAAC,CAAC;IACF,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,SAAiB,EAAE,EAAE;QACpD,KAAK,MAAM,IAAI,IAAI,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;YACzC,GAAG,CAAC,GAAG,KAAK,OAAO,EAAE,IAAI,CAAC,CAAC;YAC3B,GAAG,CAAC,GAAG,KAAK,UAAU,EAAE,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC,CAAC;IAEF,GAAG,CAAC,MAAM,EAAE,MAAA,IAAI,CAAC,QAAQ,CAAC,mCAAI,cAAM,CAAC,CAAC;IAEtC,IAAI,aAAa,KAAK,SAAS;QAAE,QAAQ,CAAC,YAAY,EAAE,IAAA,WAAI,EAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;IAEvF,QAAQ,CAAC,OAAO,EAAE,IAAA,qBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IAC7C,GAAG,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAE5C,KAAK,MAAM,QAAQ,IAAI,6CAA0B,EAAE,CAAC;QAClD,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAAE,GAAG,CAAC,eAAe,QAAQ,EAAE,EAAE,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAErB,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC;AACzD,CAAC,CAAC;AAvCW,QAAA,cAAc,kBAuCzB"}

package/src/lib/api/git.d.ts

@@ -4,6 +4,8 @@ export type GitResult = {
     stderr: string;
 };
 export declare const currentBranch: (cwd: string) => string | undefined;
+/** The commit `HEAD` names, or `undefined` outside a git checkout. */
+export declare const headCommit: (cwd: string) => string | undefined;
 /** Modified tracked files and untracked files, as git's own porcelain lines, or `undefined` when git fails. */
 export declare const uncommittedChanges: (cwd: string) => string[] | undefined;
 /** Whether git ignores a repo-relative path, or `undefined` outside a git checkout. */

package/src/lib/api/git.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.pullApiBranch = exports.checkoutApiBranch = exports.stashEntries = exports.unpushedCommits = exports.hasUncommittedChanges = exports.ignoredByGit = exports.uncommittedChanges = exports.currentBranch = void 0;
+exports.pullApiBranch = exports.checkoutApiBranch = exports.stashEntries = exports.unpushedCommits = exports.hasUncommittedChanges = exports.ignoredByGit = exports.uncommittedChanges = exports.headCommit = exports.currentBranch = void 0;
 const child_process_1 = require("child_process");
 const git = (cwd, args) => {
     var _a, _b, _c;
@@ -17,6 +17,12 @@ const currentBranch = (cwd) => {
     return result.status === 0 ? result.stdout : undefined;
 };
 exports.currentBranch = currentBranch;
+/** The commit `HEAD` names, or `undefined` outside a git checkout. */
+const headCommit = (cwd) => {
+    const result = git(cwd, ['rev-parse', 'HEAD']);
+    return result.status === 0 && result.stdout !== '' ? result.stdout : undefined;
+};
+exports.headCommit = headCommit;
 /** Modified tracked files and untracked files, as git's own porcelain lines, or `undefined` when git fails. */
 const uncommittedChanges = (cwd) => {
     const { status, stdout } = git(cwd, ['status', '--porcelain']);

package/src/lib/api/git.js.map

@@ -1 +1 @@
-{"version":3,"file":"git.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/git.ts"],"names":[],"mappings":";;;AAAA,iDAA0C;AAI1C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,IAAc,EAAa,EAAE;;IACrD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAEjE,OAAO;QACL,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,mCAAI,CAAC;QAC1B,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QACpC,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;KACrC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,IAAc,EAAE,EAAE,WAAC,OAAA,MAAA,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,mCAAI,CAAC,CAAA,EAAA,CAAC;AAE3G,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/D,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC,CAAC;AAJW,QAAA,aAAa,iBAIxB;AAEF,+GAA+G;AACxG,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,EAAE;IAChD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;IAE/D,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC,CAAC;AANW,QAAA,kBAAkB,sBAM7B;AAEF,uFAAuF;AAChF,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,IAAY,EAAE,EAAE;IACxD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7E,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9B,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1C,CAAC,CAAC;AANW,QAAA,YAAY,gBAMvB;AAEK,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE,eAAC,OAAA,CAAC,MAAA,MAAA,IAAA,0BAAkB,EAAC,GAAG,CAAC,0CAAE,MAAM,mCAAI,CAAC,CAAC,GAAG,CAAC,CAAA,EAAA,CAAC;AAApF,QAAA,qBAAqB,yBAA+D;AAEjG;;;GAGG;AACI,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,EAAE;IAC7C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAEtG,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B;AAEF,mEAAmE;AAC5D,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,EAAE;IAC1C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAEvD,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC,CAAC;AANW,QAAA,YAAY,gBAMvB;AAEF,sGAAsG;AAC/F,MAAM,iBAAiB,GAAG,CAAC,OAA6C,EAAE,EAAE;IACjF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAErC,IAAI,IAAA,qBAAa,EAAC,QAAQ,CAAC,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,cAAc,MAAM,GAAG,CAAC,CAAC;QAErC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,yBAAyB,CAAC,CAAC;QAEnD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAClD,CAAC,CAAC;AAhBW,QAAA,iBAAiB,qBAgB5B;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,CAAC,OAAsE,EAAE,EAAE;IACtG,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACpD,MAAM,MAAM,GAAG,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,yBAAyB,CAAC,CAAC;QAEpD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,cAAc,IAAI,MAAM,KAAK,cAAc,EAAE,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,MAAM,MAAM,iCAAiC,cAAc,aAAa,MAAM,KAAK,CAAC,CAAC;IACpG,CAAC;IAED,IAAI,CAAC,KAAK,IAAI,IAAA,6BAAqB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,kFAAkF,CAAC,CAAC;QAE7G,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAElE,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IAElC,IAAI,CAAC,KAAK;QAAE,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;IAEpF,OAAO,CAAC,GAAG,CAAC,mDAAmD,MAAM,GAAG,CAAC,CAAC;IAE1E,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC;AA7BW,QAAA,aAAa,iBA6BxB"}
+{"version":3,"file":"git.js","sourceRoot":"","sources":["../../../../../../libs/cli/src/lib/api/git.ts"],"names":[],"mappings":";;;AAAA,iDAA0C;AAI1C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,IAAc,EAAa,EAAE;;IACrD,MAAM,MAAM,GAAG,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IAEjE,OAAO;QACL,MAAM,EAAE,MAAA,MAAM,CAAC,MAAM,mCAAI,CAAC;QAC1B,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;QACpC,MAAM,EAAE,CAAC,MAAA,MAAM,CAAC,MAAM,mCAAI,EAAE,CAAC,CAAC,IAAI,EAAE;KACrC,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,IAAc,EAAE,EAAE,WAAC,OAAA,MAAA,IAAA,yBAAS,EAAC,KAAK,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC,MAAM,mCAAI,CAAC,CAAA,EAAA,CAAC;AAE3G,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,EAAE;IAC3C,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,cAAc,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/D,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACzD,CAAC,CAAC;AAJW,QAAA,aAAa,iBAIxB;AAEF,sEAAsE;AAC/D,MAAM,UAAU,GAAG,CAAC,GAAW,EAAE,EAAE;IACxC,MAAM,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/C,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,IAAI,MAAM,CAAC,MAAM,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACjF,CAAC,CAAC;AAJW,QAAA,UAAU,cAIrB;AAEF,+GAA+G;AACxG,MAAM,kBAAkB,GAAG,CAAC,GAAW,EAAE,EAAE;IAChD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC;IAE/D,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC,CAAC;AANW,QAAA,kBAAkB,sBAM7B;AAEF,uFAAuF;AAChF,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,IAAY,EAAE,EAAE;IACxD,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,cAAc,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,CAAC,CAAC,CAAC;IAE7E,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAE9B,OAAO,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1C,CAAC,CAAC;AANW,QAAA,YAAY,gBAMvB;AAEK,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAE,EAAE,eAAC,OAAA,CAAC,MAAA,MAAA,IAAA,0BAAkB,EAAC,GAAG,CAAC,0CAAE,MAAM,mCAAI,CAAC,CAAC,GAAG,CAAC,CAAA,EAAA,CAAC;AAApF,QAAA,qBAAqB,yBAA+D;AAEjG;;;GAGG;AACI,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,EAAE;IAC7C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAEtG,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC,CAAC;AANW,QAAA,eAAe,mBAM1B;AAEF,mEAAmE;AAC5D,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,EAAE;IAC1C,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAEvD,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,SAAS,CAAC;IAEnC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACrD,CAAC,CAAC;AANW,QAAA,YAAY,gBAMvB;AAEF,sGAAsG;AAC/F,MAAM,iBAAiB,GAAG,CAAC,OAA6C,EAAE,EAAE;IACjF,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;IAErC,IAAI,IAAA,qBAAa,EAAC,QAAQ,CAAC,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,CAAC,GAAG,CAAC,cAAc,MAAM,GAAG,CAAC,CAAC;QAErC,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC3B,OAAO,CAAC,KAAK,CAAC,IAAI,MAAM,yBAAyB,CAAC,CAAC;QAEnD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;AAClD,CAAC,CAAC;AAhBW,QAAA,iBAAiB,qBAgB5B;AAEF;;;GAGG;AACI,MAAM,aAAa,GAAG,CAAC,OAAsE,EAAE,EAAE;IACtG,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC;IACpD,MAAM,MAAM,GAAG,IAAA,qBAAa,EAAC,QAAQ,CAAC,CAAC;IAEvC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,yBAAyB,CAAC,CAAC;QAEpD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,IAAI,cAAc,IAAI,MAAM,KAAK,cAAc,EAAE,CAAC;QAChD,OAAO,CAAC,IAAI,CAAC,MAAM,MAAM,iCAAiC,cAAc,aAAa,MAAM,KAAK,CAAC,CAAC;IACpG,CAAC;IAED,IAAI,CAAC,KAAK,IAAI,IAAA,6BAAqB,EAAC,QAAQ,CAAC,EAAE,CAAC;QAC9C,OAAO,CAAC,KAAK,CAAC,GAAG,QAAQ,kFAAkF,CAAC,CAAC;QAE7G,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,CAAC;IAElE,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IAElC,IAAI,CAAC,KAAK;QAAE,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;IAEpF,OAAO,CAAC,GAAG,CAAC,mDAAmD,MAAM,GAAG,CAAC,CAAC;IAE1E,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,UAAU,MAAM,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC;AA7BW,QAAA,aAAa,iBA6BxB"}

package/src/lib/api/help.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.singleApiHelp = exports.apiHelp = void 0;
 const definition_1 = require("./definition");
+const seeds_1 = require("./seeds");
 const BUILT_IN_DESCRIPTIONS = {
     up: 'Start the containers of the API',
     down: 'Stop them',
@@ -12,7 +13,18 @@ const BUILT_IN_DESCRIPTIONS = {
     checkout: 'Switch the checkout to the branch apiRepoBranches names',
     pull: 'Fetch and fast-forward the checked-out branch',
     setup: "Run the API's own setupCommand in its compose directory",
+    exec: 'Run a command in a service without a TTY: exec <api> <service> -- <cmd...>',
+    doctor: 'Run the checks the API declares: doctor <api> [--fix]',
+    run: 'Run a host command under the API lock: run <api> --lock [--wait <s>] -- <cmd...>',
+    ready: 'Bring the data of a profile up to date and wait for health: ready <api> --profile <p>',
+    snapshot: 'Save or restore the databases of a profile: snapshot save|restore <api> <name> [--profile <p>]',
+    status: 'Print profile, fingerprints, dirty flag, snapshot and lock holder: status <api> [--profile <p>]',
 };
+const SEED_DESCRIPTIONS = {
+    seed: 'List the seeds in .ethlete/seeds/<name>/seeds.json, or run the ones you name',
+    fixtures: 'Run the fixtures of that manifest, then the seeds you name',
+};
+const isSeedCommand = (command) => seeds_1.SEED_API_COMMANDS.some((candidate) => candidate === command);
 const pad = (text, width) => text.padEnd(width);
 /** The help text for `et api`, listing the built-in commands and what each API adds to them. */
 const apiHelp = (apis, invocation) => {
@@ -20,15 +32,25 @@ const apiHelp = (apis, invocation) => {
     const width = Math.max(8, ...entries.map(([name]) => name.length));
     const commandWidth = Math.max(8, ...definition_1.BUILT_IN_API_COMMANDS.map((command) => command.length), ...entries.flatMap(([, api]) => { var _a; return Object.keys((_a = api.exec) !== null && _a !== void 0 ? _a : {}).map((command) => command.length); }));
     const apiLines = entries.map(([name, api]) => `  ${pad(name, width)}  ${(0, definition_1.apiCommandNames)(api).join(', ')}`);
-    const execNames = [...new Set(entries.flatMap(([, api]) => { var _a; return Object.keys((_a = api.exec) !== null && _a !== void 0 ? _a : {}); }))];
+    const execNames = [
+        ...new Set(entries.flatMap(([, api]) => { var _a; return Object.keys((_a = api.exec) !== null && _a !== void 0 ? _a : {}).filter((command) => !isSeedCommand(command)); })),
+    ];
     return [
-        `Usage: ${invocation} <command> <api>[,<api>] [--host]`,
+        `Usage: ${invocation} <command> <api>[,<api>] [<service> | <seed>[,<seed>]] [--host]`,
+        `       ${invocation} exec <api> <service> -- <command> [<args>...]`,
+        `       ${invocation} run <api> --lock [--wait <seconds>] -- <command> [<args>...]`,
+        `       ${invocation} ready <api> --profile <profile> [--wait <seconds>]`,
+        `       ${invocation} snapshot save|restore <api> <name> [--profile <profile>] [--wait <seconds>]`,
         '',
         'Commands',
         ...definition_1.BUILT_IN_API_COMMANDS.map((command) => `  ${pad(command, commandWidth)}  ${BUILT_IN_DESCRIPTIONS[command]}`),
+        ...seeds_1.SEED_API_COMMANDS.map((command) => `  ${pad(command, commandWidth)}  ${SEED_DESCRIPTIONS[command]}`),
         ...execNames.map((command) => `  ${pad(command, commandWidth)}  Declared by the API itself`),
         `  ${pad('help', commandWidth)}  What one API accepts, and where its checkout is`,
         '',
+        'Everything after -- goes to the command unchanged, and nothing else is written to stdout.',
+        `An exec entry named seed or fixtures in ethlete.apis.js runs instead of the built-in command.`,
+        '',
         'APIs',
         ...(apiLines.length > 0 ? apiLines : ['  none — declare them in ethlete.apis.js']),
         '',
@@ -36,6 +58,8 @@ const apiHelp = (apis, invocation) => {
         `  ${pad('--host', commandWidth)}  Also print the address another device on this network can use`,
         `  ${pad('--force', commandWidth)}  With up: start even when a port is taken. With pull or clear: lose local work`,
         `  ${pad('--all', commandWidth)}  With clear: every API at once`,
+        `  ${pad('--profile', commandWidth)}  With ready, snapshot and status: the profile to use`,
+        `  ${pad('--wait', commandWidth)}  With run, ready or snapshot restore: give up after this many seconds, with exit code 75`,
         `  ${pad('--clone', commandWidth)}  Clone a missing checkout without asking first`,
         `  ${pad('--setup', commandWidth)}  Run the setup command for a missing env file without asking first`,
         `  ${pad('--help', commandWidth)}  Show this text`,
@@ -43,11 +67,14 @@ const apiHelp = (apis, invocation) => {
 };
 exports.apiHelp = apiHelp;
 const commandDescription = (api, command) => {
-    var _a, _b;
+    var _a;
     if (command === 'setup' && api.setupCommand)
         return `Run "${api.setupCommand}" in ${api.composeDir}`;
+    const execCommand = (_a = api.exec) === null || _a === void 0 ? void 0 : _a[command];
+    if (isSeedCommand(command))
+        return execCommand ? execCommand.join(' ') : SEED_DESCRIPTIONS[command];
     const builtIn = definition_1.BUILT_IN_API_COMMANDS.find((candidate) => candidate === command);
-    return builtIn ? BUILT_IN_DESCRIPTIONS[builtIn] : ((_b = (_a = api.exec) === null || _a === void 0 ? void 0 : _a[command]) !== null && _b !== void 0 ? _b : []).join(' ');
+    return builtIn ? BUILT_IN_DESCRIPTIONS[builtIn] : (execCommand !== null && execCommand !== void 0 ? execCommand : []).join(' ');
 };
 /** The help text for one API: every command it accepts, what each one runs, and where its files are. */
 const singleApiHelp = (options) => {