npm - eidosmd - Versions diffs - 0.1.0 → 0.2.0 - Mend

eidosmd 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (100) hide show

package/README.md +50 -29
package/browser/dist/assets/index-C2NMN_D4.css +1 -0
package/browser/dist/assets/index-C65k1ihb.js +46 -0
package/browser/dist/favicon.svg +5 -0
package/browser/dist/index.html +15 -0
package/browser/dist/mark.svg +4 -0
package/dist/src/cli.js +7 -0
package/dist/src/commands/agents.js +1 -1
package/dist/src/commands/canvas.js +77 -0
package/dist/src/commands/check.js +1 -1
package/dist/src/commands/framework.js +24 -5
package/dist/src/commands/index.js +4 -4
package/dist/src/commands/init.js +1 -0
package/dist/src/commands/instructions.js +1 -1
package/dist/src/commands/list.js +8 -8
package/dist/src/commands/migrate.js +32 -0
package/dist/src/commands/new.js +3 -3
package/dist/src/commands/seeds.js +5 -5
package/dist/src/commands/setup.js +119 -0
package/dist/src/commands/version.js +44 -0
package/dist/src/commands/whoami.js +4 -4
package/dist/src/context.js +5 -5
package/dist/src/core/blueprint.js +16 -11
package/dist/src/core/canvas-schema.js +148 -0
package/dist/src/core/canvas.js +722 -0
package/dist/src/core/check.js +127 -51
package/dist/src/core/convert.js +7 -6
package/dist/src/core/framework-markdown.js +113 -34
package/dist/src/core/framework-model.js +27 -10
package/dist/src/core/framework-structured.js +132 -33
package/dist/src/core/framework.js +13 -13
package/dist/src/core/git.js +59 -0
package/dist/src/core/index-leaf.js +2 -2
package/dist/src/core/me.js +16 -8
package/dist/src/core/migrate.js +243 -0
package/dist/src/core/naming.js +1 -1
package/dist/src/core/root.js +2 -2
package/dist/src/core/scaffold.js +19 -19
package/dist/src/core/seed.js +151 -60
package/dist/src/core/server.js +1236 -52
package/dist/src/core/settings.js +181 -0
package/dist/src/core/store.js +259 -0
package/dist/src/core/template.js +32 -0
package/dist/src/core/versions.js +79 -0
package/dist/src/output.js +4 -1
package/dist/src/program.js +134 -39
package/instructions/authoring.md +13 -12
package/instructions/configuring.md +65 -34
package/instructions/init-required.md +4 -4
package/instructions/overview.md +17 -7
package/instructions/validating.md +5 -4
package/package.json +21 -12
package/standard/EIDOS.md +129 -188
package/standard/seeds/README.md +6 -6
package/standard/seeds/book/Framework.yaml +81 -0
package/standard/seeds/book/README.md +9 -5
package/standard/seeds/book/_gitignore +3 -3
package/standard/seeds/book/me.md +1 -1
package/standard/seeds/book/roles/README.md +3 -3
package/standard/seeds/book/roles/framework-owner.md +2 -2
package/standard/seeds/book/{shapes → templates}/chapter.full.md +0 -8
package/standard/seeds/book/{shapes → templates}/chapter.sketch.md +0 -7
package/standard/seeds/book/{shapes → templates}/frame.market.md +0 -6
package/standard/seeds/book/templates/frame.premise.md +17 -0
package/standard/seeds/book/{shapes → templates}/frame.reader.md +0 -6
package/standard/seeds/book/{shapes → templates}/frame.voice.md +0 -7
package/standard/seeds/research/Framework.yaml +81 -0
package/standard/seeds/research/README.md +9 -5
package/standard/seeds/research/_gitignore +3 -3
package/standard/seeds/research/me.md +1 -1
package/standard/seeds/research/roles/README.md +3 -3
package/standard/seeds/research/roles/framework-owner.md +2 -2
package/standard/seeds/research/{shapes → templates}/frame.ethics.md +0 -6
package/standard/seeds/research/{shapes → templates}/frame.method.md +0 -7
package/standard/seeds/research/{shapes → templates}/frame.prior-work.md +0 -6
package/standard/seeds/research/{shapes → templates}/frame.question.md +0 -7
package/standard/seeds/research/{shapes → templates}/investigation.full.md +0 -8
package/standard/seeds/research/{shapes → templates}/investigation.note.md +0 -7
package/standard/seeds/software/Framework.yaml +82 -0
package/standard/seeds/software/README.md +5 -5
package/standard/seeds/software/_gitignore +3 -3
package/standard/seeds/software/me.md +1 -1
package/standard/seeds/software/roles/README.md +3 -3
package/standard/seeds/software/roles/framework-owner.md +2 -2
package/standard/seeds/software/roles/project-manager.md +2 -2
package/standard/seeds/software/roles/stakeholder.md +1 -1
package/standard/seeds/software/{shapes → templates}/frame.architecture.md +0 -7
package/standard/seeds/software/{shapes → templates}/frame.audience.md +1 -8
package/standard/seeds/software/{shapes → templates}/frame.criteria.md +0 -8
package/standard/seeds/software/{shapes → templates}/frame.market.md +0 -8
package/standard/seeds/software/{shapes → templates}/spec.full.md +0 -8
package/standard/seeds/software/{shapes → templates}/spec.micro.md +0 -9
package/browser/index.html +0 -268
package/dist/src/commands/convert.js +0 -30
package/dist/src/core/shape.js +0 -26
package/standard/seeds/book/Framework.md +0 -87
package/standard/seeds/book/shapes/frame.premise.md +0 -24
package/standard/seeds/research/Framework.md +0 -88
package/standard/seeds/software/Framework.md +0 -88
/package/standard/seeds/software/{shapes → templates}/.gitkeep +0 -0

package/browser/dist/favicon.svg ADDED Viewed

@@ -0,0 +1,5 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" role="img" aria-label="Eidos">
+  <rect width="32" height="32" rx="7" fill="#000000"/>
+  <rect x="5.1" y="5.1" width="21.8" height="21.8" rx="5" fill="none" stroke="#e08a63" stroke-width="1.8" opacity="0.5"/>
+  <path d="M16 9.4 21.9 16 16 22.6 10.1 16 16 9.4Z" fill="#e08a63"/>
+</svg>

package/browser/dist/index.html ADDED Viewed

@@ -0,0 +1,15 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="color-scheme" content="dark light" />
+    <link rel="icon" href="/favicon.svg" type="image/svg+xml" />
+    <title>Eidos</title>
+    <script type="module" crossorigin src="/assets/index-C65k1ihb.js"></script>
+    <link rel="stylesheet" crossorigin href="/assets/index-C2NMN_D4.css">
+  </head>
+  <body>
+    <div id="app"></div>
+  </body>
+</html>

package/browser/dist/mark.svg ADDED Viewed

@@ -0,0 +1,4 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32" fill="none" role="img" aria-label="Eidos">
+  <rect x="2.75" y="2.75" width="26.5" height="26.5" rx="6.25" stroke="#e08a63" stroke-width="1.9" opacity="0.42"/>
+  <path d="M16 8.6 22.9 16 16 23.4 9.1 16 16 8.6Z" fill="#e08a63"/>
+</svg>

package/dist/src/cli.js CHANGED Viewed

@@ -2,4 +2,11 @@
 // The executable entry point: one root of Eidos blueprints, scaffolded,
 // validated, and indexed from the shell.
 import { buildProgram } from './program.js';
+// A reader that closes the pipe early (`eidos framework | head`) is not an
+// error worth a stack trace: stop writing and leave quietly.
+process.stdout.on('error', (error) => {
+    if (error.code === 'EPIPE')
+        process.exit(0);
+    throw error;
+});
 buildProgram().parse(process.argv);

package/dist/src/commands/agents.js CHANGED Viewed

@@ -10,7 +10,7 @@ export function nudge() {
         NUDGE_START,
         '## Eidos',
         '',
-        'This repository keeps its blueprints in an Eidos root. Before creating, editing, reviewing, or discussing a blueprint or the framework, run `eidos instructions overview` and follow it; it names the guide to read for each kind of work. Use the `eidos` CLI for structure (`eidos new`, `eidos check`, `eidos index`); never hand-assemble frontmatter or edit an `index.md`.',
+        'This repository keeps its blueprints in an Eidos root. Before creating, editing, reviewing, or discussing a blueprint or the framework, run `eidos instructions overview` and follow it; it names the guide to read for each kind of work. Use the `eidos` CLI for structure (`eidos new`, `eidos check`, `eidos index`); never hand-assemble frontmatter or edit the generated index in the framework document.',
         NUDGE_END,
     ].join('\n');
 }

package/dist/src/commands/canvas.js ADDED Viewed

@@ -0,0 +1,77 @@
+// `eidos canvas`: the canvas maps a root keeps under .eidos/plugins/eidosmd/maps/, listed or
+// created from the shell; the browser is where they are drawn.
+import { readFileSync } from 'node:fs';
+import path from 'node:path';
+import { stringify } from 'yaml';
+import { createCanvas, findPage, listCanvases, loadCanvas, CanvasError } from '../core/canvas.js';
+import { CANVAS_SCHEMA } from '../core/canvas-schema.js';
+import { CliError, EXIT_OK, print, printJson } from '../output.js';
+export function runCanvasList(context, options) {
+    const canvases = listCanvases(context.framework);
+    if (options.json) {
+        printJson(canvases.map((canvas) => ({ id: canvas.id, title: canvas.title, path: path.relative(context.root, canvas.file).split(path.sep).join('/'), pages: canvas.pages.map((page) => ({ id: page.id, title: page.title, nodes: page.nodes.length, edges: page.edges.length })), problems: canvas.problems })));
+        return EXIT_OK;
+    }
+    if (canvases.length === 0) {
+        print('no canvases under .eidos/plugins/eidosmd/maps/; create one: eidos canvas new "<title>", or open eidos browser');
+        return EXIT_OK;
+    }
+    for (const canvas of canvases) {
+        print(`${canvas.id}  —  ${canvas.title}`);
+        for (const page of canvas.pages) {
+            print(`  ${page.id}: ${page.title} (${page.nodes.length} node${page.nodes.length === 1 ? '' : 's'}, ${page.edges.length} edge${page.edges.length === 1 ? '' : 's'})`);
+        }
+    }
+    return EXIT_OK;
+}
+export function runCanvasNew(context, title, options) {
+    let canvas;
+    try {
+        canvas = createCanvas(context.framework, title);
+    }
+    catch (cause) {
+        if (cause instanceof CanvasError) {
+            throw new CliError(cause.message);
+        }
+        throw cause;
+    }
+    const rel = path.relative(context.root, canvas.file).split(path.sep).join('/');
+    if (options.json) {
+        printJson({ id: canvas.id, title: canvas.title, path: rel });
+        return EXIT_OK;
+    }
+    print(`✓ ${rel}  (canvas ${canvas.id}, one page: overview)`, '  next: eidos browser, and draw');
+    return EXIT_OK;
+}
+// The file as it is, or one page of it, for a person or an agent about to edit it.
+export function runCanvasShow(context, id, options) {
+    let canvas;
+    try {
+        canvas = loadCanvas(context.framework, id);
+        if (options.page !== undefined) {
+            const page = findPage(canvas, options.page);
+            if (options.json)
+                printJson(page);
+            else
+                print(stringify(page).trimEnd());
+            return EXIT_OK;
+        }
+    }
+    catch (cause) {
+        if (cause instanceof CanvasError) {
+            throw new CliError(cause.message);
+        }
+        throw cause;
+    }
+    if (options.json) {
+        printJson({ id: canvas.id, title: canvas.title, path: path.relative(context.root, canvas.file).split(path.sep).join('/'), pages: canvas.pages, problems: canvas.problems });
+        return EXIT_OK;
+    }
+    print(readFileSync(canvas.file, 'utf8').trimEnd());
+    return EXIT_OK;
+}
+// The JSON Schema of the file, for whoever edits one without the browser.
+export function runCanvasSchema() {
+    printJson(CANVAS_SCHEMA);
+    return EXIT_OK;
+}

package/dist/src/commands/check.js CHANGED Viewed

@@ -16,7 +16,7 @@ export function runCheck(context, paths, options) {
             const resolved = path.resolve(context.cwd, given);
             const match = context.blueprints.find((blueprint) => path.resolve(blueprint.path) === resolved);
             if (!match) {
-                throw new CliError(`${given} is not a blueprint in ${context.root} (not in a declared collection, or an index.md)`);
+                throw new CliError(`${given} is not a blueprint in ${context.root} (not in a declared collection)`);
             }
             only.add(match.path);
         }

package/dist/src/commands/framework.js CHANGED Viewed

@@ -1,7 +1,8 @@
 // `eidos framework`: what the root's framework document declares, as a human
 // summary, as JSON an agent can read instead of parsing the file, or as the
-// YAML document a scriptable root keeps on disk.
+// document itself, normalized.
 import path from 'node:path';
+import { unitOf } from '../core/framework-model.js';
 import { frameworkToDocument, serializeDocument } from '../core/framework-structured.js';
 import { CliError, EXIT_OK, print, printJson } from '../output.js';
 export function frameworkJson(framework) {
@@ -16,7 +17,7 @@ export function runFramework(context, options) {
     const { framework } = context;
     if (options.as !== undefined) {
         if (options.as !== 'yaml') {
-            throw new CliError('--as takes yaml (the markdown form is authored, not generated)');
+            throw new CliError('--as takes yaml');
         }
         process.stdout.write(serializeDocument(frameworkToDocument(framework)));
         return EXIT_OK;
@@ -44,6 +45,10 @@ export function runFramework(context, options) {
         if (collection.framing) {
             tags.push('framing');
         }
+        const unit = unitOf(collection);
+        if (unit) {
+            tags.push(`unit: ${unit}`);
+        }
         if (collection.grouping) {
             tags.push(`grouped by ${collection.grouping.label}${collection.grouping.property ? ` (\`${collection.grouping.property}\`)` : ''}`);
         }
@@ -54,13 +59,13 @@ export function runFramework(context, options) {
         if (collection.description) {
             print(`    ${collection.description}`);
         }
-        const flavors = collection.flavors.map((flavor) => `${flavor.name}${flavor.isDefault ? ' (default)' : ''}`);
-        print(`    flavors: ${flavors.length > 0 ? flavors.join(', ') : 'none declared'}`);
+        const variants = collection.variants.map((variant) => `${variant.name}${variant.isDefault ? ' (default)' : ''}`);
+        print(`    variants: ${variants.length > 0 ? variants.join(', ') : 'none declared'}`);
         if (collection.grouping && collection.grouping.groups.length > 0) {
             print(`    groups: ${collection.grouping.groups.map((group) => group.name).join(', ')}`);
         }
     }
-    print('', 'Schema');
+    print('', 'Properties');
     print(`  core:   ${framework.schema.core.map((property) => property.name).join(', ')}`);
     if (framework.schema.custom.length === 0) {
         print('  custom: none');
@@ -68,9 +73,23 @@ export function runFramework(context, options) {
     else {
         print('  custom:');
         for (const property of framework.schema.custom) {
+            const scope = property.appliesTo === 'all' ? 'all' : property.appliesTo.join(', ');
+            const tools = property.tools ? `  [${Object.keys(property.tools).join(', ')}]` : '';
+            print(`    ${property.name} (${property.type}, ${scope}) — ${property.meaning}${tools}`);
+        }
+    }
+    for (const [tool, block] of Object.entries(framework.schema.tools)) {
+        print(`  ${tool} (the tool's own block):`);
+        for (const property of block) {
             const scope = property.appliesTo === 'all' ? 'all' : property.appliesTo.join(', ');
             print(`    ${property.name} (${property.type}, ${scope}) — ${property.meaning}`);
         }
     }
+    if (framework.vocabulary.length > 0) {
+        print('', 'Vocabulary');
+        for (const term of framework.vocabulary) {
+            print(`  ${term.term}: ${term.means}${term.not.length > 0 ? `  (not: ${term.not.join('; ')})` : ''}`);
+        }
+    }
     return EXIT_OK;
 }

package/dist/src/commands/index.js CHANGED Viewed

@@ -1,4 +1,4 @@
-// `eidos index`: regenerate each collection's index.md, or verify them with --check.
+// `eidos index`: regenerate each collection's index in the framework document, or verify them with --check.
 import path from 'node:path';
 import { buildIndexes } from '../core/index-leaf.js';
 import { findCollection } from '../core/framework.js';
@@ -9,13 +9,13 @@ export function runIndex(context, options) {
         collections = options.collection.map((name) => {
             const found = findCollection(context.framework, name);
             if (!found) {
-                throw new CliError(`collection '${name}' is not declared in Framework.md`);
+                throw new CliError(`collection '${name}' is not declared in the framework document`);
             }
             return found;
         });
     }
     if (context.framework.collections.length === 0) {
-        throw new CliError('no collections declared in _eidos/Framework.md (## Collections)');
+        throw new CliError('no collections declared in the framework document');
     }
     const results = buildIndexes(context.framework, context.blueprints, { collections, check: options.check });
     const stale = results.some((result) => result.status === 'stale');
@@ -39,7 +39,7 @@ export function runIndex(context, options) {
         const count = `${result.count} blueprint${result.count === 1 ? '' : 's'}`;
         switch (result.status) {
             case 'folder-missing':
-                printError(`  ✗ ${result.collection.name}: folder not found (${path.dirname(result.file)})`);
+                printError(`  ✗ ${result.collection.name}: folder not found (${path.join(context.root, result.collection.name)})`);
                 break;
             case 'stale':
                 print(`  ✗ stale: ${relFile}`);

package/dist/src/commands/init.js CHANGED Viewed

@@ -23,6 +23,7 @@ export function runInit(rootArg, options, cwd = process.cwd()) {
             naming,
             groups: options.group,
             product: options.product ?? null,
+            framing: options.framing,
             date: options.date,
             dryRun: options.dryRun,
         });

package/dist/src/commands/instructions.js CHANGED Viewed

@@ -8,7 +8,7 @@ export const GUIDES = [
     { name: 'overview', summary: 'Required first read before answering any request in a root' },
     { name: 'authoring', summary: 'How to place, scaffold, fill, and check a blueprint with the owner' },
     { name: 'validating', summary: 'How to run a check, read its findings, and report a review' },
-    { name: 'configuring', summary: 'How to add a collection, a flavor, or a property, and keep the Framework current' },
+    { name: 'configuring', summary: 'How to add a collection, a variant, or a property, and keep the Framework current' },
     { name: 'init-required', summary: 'How to create a root when there is none here' },
 ];
 export function guideText(name) {

package/dist/src/commands/list.js CHANGED Viewed

@@ -1,17 +1,17 @@
 // `eidos list`: the blueprints in the root, filterable by collection, group,
-// flavor, or any property value.
-import { blueprintId, blueprintTitle, propertyString, resolveFlavor } from '../core/blueprint.js';
+// variant, or any property value.
+import { blueprintId, blueprintTitle, propertyString, resolveVariant } from '../core/blueprint.js';
 import { findCollection } from '../core/framework.js';
 import { CliError, EXIT_OK, print, printJson, table } from '../output.js';
 export function blueprintJson(blueprint) {
-    const { flavor, declared } = resolveFlavor(blueprint);
+    const { variant, declared } = resolveVariant(blueprint);
     return {
         id: blueprintId(blueprint),
         title: blueprintTitle(blueprint),
         summary: propertyString(blueprint, 'summary'),
         collection: blueprint.collection.name,
         group: blueprint.group,
-        flavor: flavor?.name ?? declared,
+        variant: variant?.name ?? declared,
         path: blueprint.rel,
         properties: blueprint.properties ?? {},
     };
@@ -46,9 +46,9 @@ export function runList(context, collectionArg, options) {
         const wanted = options.group.toLowerCase();
         selected = selected.filter((blueprint) => blueprint.group?.toLowerCase() === wanted);
     }
-    if (options.flavor !== undefined) {
-        const wanted = options.flavor.toLowerCase();
-        selected = selected.filter((blueprint) => resolveFlavor(blueprint).flavor?.name.toLowerCase() === wanted);
+    if (options.variant !== undefined) {
+        const wanted = options.variant.toLowerCase();
+        selected = selected.filter((blueprint) => resolveVariant(blueprint).variant?.name.toLowerCase() === wanted);
     }
     for (const clause of options.where) {
         selected = selected.filter((blueprint) => matchesWhere(blueprint, clause));
@@ -65,7 +65,7 @@ export function runList(context, collectionArg, options) {
         blueprintId(blueprint) ?? '(no id)',
         blueprintTitle(blueprint),
         blueprint.group === null ? blueprint.collection.name : `${blueprint.collection.name}/${blueprint.group}`,
-        resolveFlavor(blueprint).flavor?.name ?? '?',
+        resolveVariant(blueprint).variant?.name ?? '?',
     ]);
     print(...table([['ID', 'TITLE', 'COLLECTION', 'FLAVOR'], ...rows]));
     print('', `${selected.length} blueprint${selected.length === 1 ? '' : 's'}`);

package/dist/src/commands/migrate.js ADDED Viewed

@@ -0,0 +1,32 @@
+// `eidos migrate`: move a root to the standard this CLI carries, mechanically,
+// and say what moved.
+import { findMigratableRoot, migrateRoot, MigrationError } from '../core/migrate.js';
+import { CliError, EXIT_OK, print, printJson } from '../output.js';
+export function runMigrate(options, cwd = process.cwd()) {
+    let report;
+    try {
+        report = migrateRoot(findMigratableRoot(cwd, options.root), { dryRun: options.dryRun });
+    }
+    catch (cause) {
+        if (cause instanceof MigrationError)
+            throw new CliError(cause.message);
+        throw cause;
+    }
+    if (options.json) {
+        printJson(report);
+        return EXIT_OK;
+    }
+    if (report.actions.length === 0) {
+        print(`${report.root} already targets Eidos ${report.to}; nothing to move`);
+    }
+    else {
+        print(`${options.dryRun ? 'would move' : 'moved'} ${report.root} from Eidos ${report.from ?? '?'} to ${report.to}:`);
+        for (const action of report.actions)
+            print(`  ${options.dryRun ? '·' : '✓'} ${action}`);
+    }
+    for (const note of report.notes)
+        print(`  ! ${note}`);
+    if (!options.dryRun && report.actions.length > 0)
+        print('', 'next: eidos check');
+    return EXIT_OK;
+}

package/dist/src/commands/new.js CHANGED Viewed

@@ -20,7 +20,7 @@ export function runNew(context, collection, titleWords, options) {
         result = scaffoldBlueprint(context.framework, context.blueprints, {
             collection,
             title: titleWords.join(' '),
-            flavor: options.flavor ?? null,
+            variant: options.variant ?? null,
             group: options.group ?? null,
             id: options.id ?? null,
             summary: options.summary ?? null,
@@ -45,7 +45,7 @@ export function runNew(context, collection, titleWords, options) {
             id: result.id,
             collection: result.collection.name,
             group: result.group,
-            flavor: result.flavor.name,
+            variant: result.variant.name,
             dry_run: options.dryRun,
             notes: result.notes,
             content: options.dryRun ? result.content : undefined,
@@ -56,7 +56,7 @@ export function runNew(context, collection, titleWords, options) {
         print(`would write ${result.rel}:`, '', result.content);
     }
     else {
-        print(`✓ ${result.rel}  (${result.collection.name}, ${result.flavor.kind}.${result.flavor.name}, id ${result.id})`);
+        print(`✓ ${result.rel}  (${result.collection.name}, ${result.variant.unit}.${result.variant.name}, id ${result.id})`);
     }
     for (const note of result.notes) {
         print(`  ! ${note}`);

package/dist/src/commands/seeds.js CHANGED Viewed

@@ -1,4 +1,4 @@
-// `eidos seeds`: the bundled starting frameworks, read from their own Framework.md.
+// `eidos seeds`: the bundled starting frameworks, read from their own Framework.yaml.
 import { listSeeds } from '../core/seed.js';
 import { seedsDir } from '../paths.js';
 import { EXIT_OK, print, printJson } from '../output.js';
@@ -13,7 +13,7 @@ export function runSeeds(options) {
                 framing: collection.framing,
                 description: collection.description,
                 grouping: collection.grouping?.label ?? null,
-                flavors: collection.flavors.map((flavor) => ({ name: flavor.name, description: flavor.description, default: flavor.isDefault })),
+                variants: collection.variants.map((variant) => ({ name: variant.name, description: variant.description, default: variant.isDefault })),
             })),
         })));
         return EXIT_OK;
@@ -29,9 +29,9 @@ export function runSeeds(options) {
                 role = `grouped by ${collection.grouping.label.toLowerCase()}`;
             }
             print(`  ${collection.name} — ${role}`, `    ${collection.description}`);
-            for (const flavor of collection.flavors) {
-                const marker = flavor.isDefault ? ' (default)' : '';
-                print(flavor.description ? `    · ${flavor.name} — ${flavor.description}${marker}` : `    · ${flavor.name}${marker}`);
+            for (const variant of collection.variants) {
+                const marker = variant.isDefault ? ' (default)' : '';
+                print(variant.description ? `    · ${variant.name} — ${variant.description}${marker}` : `    · ${variant.name}${marker}`);
             }
         }
     }

package/dist/src/commands/setup.js ADDED Viewed

@@ -0,0 +1,119 @@
+// `eidos setup`: the CLI's own settings for a root, asked in the terminal or
+// given as flags: whether git is read, the people who work here (name, alias
+// for @mentions, role from .eidos/roles/, email), and who this machine acts
+// as. Writes .eidos/plugins/eidosmd/settings.yaml (shared) and local.yaml
+// (personal); nothing of the standard's changes.
+import { createInterface } from 'node:readline/promises';
+import { gitHead, gitUser } from '../core/git.js';
+import { listRoles } from '../core/me.js';
+import { cleanAlias, findUser, matchesIdentity, readSettings, writeSettings } from '../core/settings.js';
+import { CliError, EXIT_OK, print, printJson } from '../output.js';
+const interactive = () => process.stdin.isTTY === true && process.stdout.isTTY === true;
+// One line, with a default shown in brackets; an empty answer takes it.
+async function ask(question, fallback) {
+    const rl = createInterface({ input: process.stdin, output: process.stdout });
+    try {
+        const answer = (await rl.question(`${question}${fallback === '' ? '' : ` [${fallback}]`}: `)).trim();
+        return answer === '' ? fallback : answer;
+    }
+    finally {
+        rl.close();
+    }
+}
+export async function askYesNo(question, fallback) {
+    const answer = (await ask(`${question} (${fallback ? 'Y/n' : 'y/N'})`, '')).toLowerCase();
+    if (answer === '')
+        return fallback;
+    return answer.startsWith('y');
+}
+const onOff = (value) => (value === undefined ? null : /^(on|true|yes|1)$/i.test(value) ? true : /^(off|false|no|0)$/i.test(value) ? false : null);
+function describe(root, settings) {
+    const inRepo = gitHead(root) !== null;
+    const identity = inRepo ? gitUser(root) : null;
+    const lines = [
+        `git features: ${settings.shared.features.git ? 'on' : 'off'}${inRepo ? '' : ' (this root is not in a git repository)'}${identity ? `; git identity ${identity.name}${identity.email ? ` <${identity.email}>` : ''}` : ''}`,
+        settings.shared.users.length === 0 ? 'users: none' : `users: ${settings.shared.users.map((user) => `${user.name}${user.alias ? ` (@${user.alias})` : ''}${user.role ? ` · ${user.role}` : ''}`).join(', ')}`,
+        `acting as: ${settings.local.user ?? (identity ? `the git identity (${identity.name})` : 'the role in me.md')}`,
+        `files: ${settings.files.shared} (shared), ${settings.files.local} (yours, gitignored)`,
+    ];
+    return lines;
+}
+// After `eidos init` in a terminal: the one question worth asking at once.
+// Anywhere else the root stays unconfigured and the browser asks instead.
+export async function offerGit(root) {
+    if (!interactive() || readSettings(root).configured)
+        return;
+    const inRepo = gitHead(root) !== null;
+    const git = await askYesNo(`Use git features in the browser (history, authors, versions)?${inRepo ? '' : ' The root is not in a repository yet'}`, true);
+    writeSettings(root, { shared: { features: { git } } });
+    print(`  git features ${git ? 'on' : 'off'} (eidos setup changes it, and adds the people who work here)`);
+}
+export async function runSetup(context, options) {
+    const root = context.root;
+    let settings = readSettings(root);
+    const flagged = options.git !== undefined || options.addUser.length > 0 || options.as !== undefined;
+    if (flagged) {
+        const git = onOff(options.git);
+        if (options.git !== undefined && git === null)
+            throw new CliError('--git takes on or off');
+        const users = settings.shared.users.map((user) => ({ ...user }));
+        for (const name of options.addUser) {
+            if (name.trim() === '')
+                throw new CliError('--add-user needs a name');
+            const alias = cleanAlias(options.alias) ?? null;
+            const holder = alias ? findUser(users, alias) : undefined;
+            if (holder && holder.name !== name.trim())
+                throw new CliError(`the alias @${alias} is taken`);
+            const held = users.find((user) => user.name.toLowerCase() === name.trim().toLowerCase());
+            const entry = { name: name.trim(), alias: alias ?? held?.alias ?? null, role: options.role ?? held?.role ?? null, email: options.email ?? held?.email ?? null };
+            if (entry.role && !listRoles(root).some((role) => role.name === entry.role))
+                throw new CliError(`no role '${entry.role}' under .eidos/roles/ (eidos roles lists them)`);
+            if (held)
+                Object.assign(held, entry);
+            else
+                users.push(entry);
+        }
+        if (options.as !== undefined && options.as !== '' && !findUser(users, options.as))
+            throw new CliError(`no user '${options.as}'; add one with --add-user`);
+        settings = writeSettings(root, {
+            shared: { ...(git === null ? {} : { features: { git } }), ...(options.addUser.length > 0 ? { users } : {}) },
+            ...(options.as !== undefined ? { local: { user: options.as === '' ? null : options.as } } : {}),
+        });
+    }
+    else if (interactive()) {
+        print(...describe(root, settings), '');
+        const inRepo = gitHead(root) !== null;
+        const git = await askYesNo(`Use git features in the browser (history, authors, versions)?${inRepo ? '' : ' The root is not in a repository yet'}`, settings.shared.features.git);
+        const users = settings.shared.users.map((user) => ({ ...user }));
+        const identity = git && inRepo ? gitUser(root) : null;
+        let acting = settings.local.user;
+        if (identity && !users.some((user) => matchesIdentity(user, identity))) {
+            if (await askYesNo(`Add ${identity.name}${identity.email ? ` <${identity.email}>` : ''} as a user?`, true)) {
+                const alias = cleanAlias(await ask('Alias for @mentions (no spaces)', identity.name.split(/\s+/)[0]?.toLowerCase() ?? ''));
+                const roles = listRoles(root).map((role) => role.name);
+                const role = roles.length === 0 ? '' : await ask(`Role in this framework (${roles.join(', ')}; blank for none)`, '');
+                if (role !== '' && !roles.includes(role))
+                    throw new CliError(`no role '${role}' under .eidos/roles/`);
+                users.push({ name: identity.name, alias, role: role === '' ? null : role, email: identity.email });
+                acting = alias ?? identity.name;
+            }
+        }
+        if (users.length > 0) {
+            const answer = await ask(`Act as (${users.map((user) => user.alias ?? user.name).join(', ')}; blank for the git identity)`, acting ?? '');
+            if (answer !== '' && !findUser(users, answer))
+                throw new CliError(`no user '${answer}'`);
+            acting = answer === '' ? null : answer;
+        }
+        settings = writeSettings(root, { shared: { features: { git }, users }, local: { user: acting } });
+    }
+    else {
+        print(...describe(root, settings), '', 'not a terminal: set values with flags, e.g. eidos setup --git on --add-user "Ada Lovelace" --alias ada --role developer --as ada');
+        return EXIT_OK;
+    }
+    if (options.json) {
+        printJson({ shared: settings.shared, local: settings.local, files: settings.files });
+        return EXIT_OK;
+    }
+    print('✓ settings written', ...describe(root, settings).map((line) => `  ${line}`));
+    return EXIT_OK;
+}

package/dist/src/commands/version.js ADDED Viewed

@@ -0,0 +1,44 @@
+// `eidos version`: the root's own versions, this CLI's own record under
+// .eidos/plugins/eidosmd/, listed, or one recorded because the owner asked: a
+// name, a commit that exists, and a tag only on --tag. Never proposed; an
+// empty list is the normal state.
+import path from 'node:path';
+import { readVersions, recordVersion, TAG_PREFIX, VersionError, versionsFile } from '../core/versions.js';
+import { CliError, EXIT_OK, print, printJson } from '../output.js';
+export function runVersionList(context, options) {
+    const versions = readVersions(context.root);
+    if (options.json) {
+        printJson(versions);
+        return EXIT_OK;
+    }
+    if (versions.length === 0) {
+        print('no versions recorded (the normal state); record one when a team needs a fixed point: eidos version record <version> [--commit <sha>] [--tag]');
+        return EXIT_OK;
+    }
+    for (const version of versions) {
+        print(`${version.version}  ${version.commit}${version.tag ? `  ${version.tag}` : ''}`);
+    }
+    return EXIT_OK;
+}
+export function runVersionRecord(context, version, options) {
+    let recorded;
+    try {
+        recorded = recordVersion(context.root, { version, commit: options.commit, tag: options.tag });
+    }
+    catch (cause) {
+        if (cause instanceof VersionError) {
+            throw new CliError(cause.message);
+        }
+        throw cause;
+    }
+    if (options.json) {
+        printJson({ ...recorded.version, tagged: recorded.tagged });
+        return EXIT_OK;
+    }
+    print(`✓ ${recorded.version.version} → ${recorded.version.commit}${recorded.version.tag ? `  tagged ${recorded.version.tag}` : ''}`);
+    if (!recorded.version.tag) {
+        print(`  (no tag; --tag would have created ${TAG_PREFIX}${recorded.version.version})`);
+    }
+    print(`  recorded in ${path.relative(context.root, versionsFile(context.root))}; the commit that adds it is not the one it names, the way a tag follows the commit it marks`);
+    return EXIT_OK;
+}

package/dist/src/commands/whoami.js CHANGED Viewed

@@ -11,7 +11,7 @@ export function runRoles(context, options) {
         return EXIT_OK;
     }
     if (roles.length === 0) {
-        print('no roles installed under _eidos/roles/; an older framework, or one that declares none');
+        print('no roles installed under .eidos/roles/; an older framework, or one that declares none');
         return EXIT_OK;
     }
     for (const role of roles) {
@@ -43,7 +43,7 @@ export function runWhoami(context, options) {
             if (!role) {
                 if (options.role !== undefined && listRoles(context.root).length > 0) {
                     const known = listRoles(context.root).map((candidate) => candidate.name).join(', ');
-                    throw new CliError(`no role '${options.role}' under _eidos/roles/ (installed: ${known}); a custom role is set by editing _eidos/me.md`);
+                    throw new CliError(`no role '${options.role}' under .eidos/roles/ (installed: ${known}); a custom role is set by editing .eidos/me.md`);
                 }
                 custom = roleName;
             }
@@ -67,7 +67,7 @@ export function runWhoami(context, options) {
         return EXIT_OK;
     }
     if (!exists) {
-        print('no _eidos/me.md: the actor is unset, so the agent defaults to full facilitation', 'set it: eidos whoami --role <name>');
+        print('no .eidos/me.md: the actor is unset, so the agent defaults to full facilitation', 'set it: eidos whoami --role <name>');
         return EXIT_OK;
     }
     if (actor.role === null) {
@@ -75,7 +75,7 @@ export function runWhoami(context, options) {
         return runRoles(context, { json: false });
     }
     print(`you are: ${actor.role}`);
-    const roleFile = actor.roleFile ? path.resolve(context.root, '_eidos', actor.roleFile) : null;
+    const roleFile = actor.roleFile ? path.resolve(context.root, '.eidos', actor.roleFile) : null;
     if (roleFile && existsSync(roleFile)) {
         print(`role file: ${path.relative(context.root, roleFile).split(path.sep).join('/')}`, '', readFileSync(roleFile, 'utf8').trimEnd(), '');
     }

package/dist/src/context.js CHANGED Viewed

@@ -4,9 +4,9 @@ import { listBlueprints } from './core/blueprint.js';
 import { FrameworkError, loadFramework } from './core/framework.js';
 import { findRoot, RootError } from './core/root.js';
 import { CliError, EXIT_USAGE } from './output.js';
-// The CLI works on Framework.yaml. A root that keeps Framework.md is read only
-// to convert it (or to print it), so every other command points at `convert`.
-export function loadRoot(globals, cwd = process.cwd(), options = {}) {
+// The framework document is Framework.yaml. A root that still keeps the
+// 4.x Framework.md is read only by `migrate`, so every command points there.
+export function loadRoot(globals, cwd = process.cwd()) {
     let root;
     try {
         root = findRoot(cwd, globals.root);
@@ -28,8 +28,8 @@ export function loadRoot(globals, cwd = process.cwd(), options = {}) {
         }
         throw cause;
     }
-    if (framework.format === 'md' && !options.allowMarkdown) {
-        throw new CliError(`${root} keeps its framework as _eidos/Framework.md. The eidos CLI works on Framework.yaml: run \`eidos convert\` to move it (Framework.md and each collection's index.md are removed; the markdown form's prose has no field to land in). \`eidos convert --dry-run\` shows the writes, and \`eidos framework --as yaml\` prints the result without touching anything.`, EXIT_USAGE);
+    if (framework.format === 'md') {
+        throw new CliError(`${root} keeps its framework as .eidos/Framework.md, the form before Eidos 5.0.0. Run \`eidos migrate\` to move it: Framework.yaml takes its place with the index inside, and Framework.md and each collection's index.md are removed (the markdown form's prose has no field to land in). \`eidos migrate --dry-run\` lists the moves without touching anything.`, EXIT_USAGE);
     }
     return { cwd, root, framework, blueprints: listBlueprints(framework) };
 }