@mason-data/cli 0.6.2 → 0.8.0

package/dist/src/cli/init.js

@@ -1,16 +1,24 @@
 /**
  * `mason init [<postgres url>]` (a project directory is initiated as other CLIs do it, by `mason init`):
- * makes the folder it is run in a Mason project. The database's URL comes from the argument, else the folder's
- * `.env.local` or `.env` (`DATABASE_URL`, the variable web frameworks use), else the shell's. The database is checked as
- * `mason start` checks it (checkSource) and nothing is written when it fails, unless --skip-check says the database is
- * not up yet.
+ * makes the folder it is run in a Mason project. The database's URL comes from the argument, else `MASON_DATABASE_URL`
+ * (Mason's own, for a database other than the app's), else `DATABASE_URL` (the variable web frameworks use), each from
+ * the folder's `.env.local`, then `.env`, then the shell (`appDatabaseUrl`) — or, when a sources file is here already (a
+ * clone), the variable its `url: ${…}` names, read the same way, so the database checked is the one the run copies from.
+ * The database is checked as `mason start` checks it (checkSource) and nothing is written when it fails, unless
+ * --skip-check says the database is not up yet.
  *
  * It writes `.mason/config.json` (0600: the project's name and Mason's key), the project's source file
- * (`mason/sources/<database>.yml`, src/cli/sources.ts: `kind: postgres`, `url: ${DATABASE_URL}`, `tables: {}`) — the
- * URL itself in `.env`, never in a committed file (the sources file is the developer's to commit, so the URL stays out
- * of it): nothing more when it came from there, the line added when it came from the argument or the shell — and adds
- * `.mason/` and that .env to the folder's .gitignore. It refuses a folder that is in a project already (here or above)
- * — but for a project with no source file (one an older Mason made), whose source file it writes, nothing else changed.
+ * (`mason/sources/<database>.yml`, src/cli/sources.ts: `kind: postgres`, `url: ${DATABASE_URL}` — or the variable the
+ * URL was read from, `tables: {}`, and `database: <name>` only under `--database`) — the URL itself in `.env`, never in a committed file (the sources file is the
+ * developer's to commit, so the URL stays out of it): nothing more when it came from there, the line added when it came
+ * from the argument or the shell — and adds `.mason/` and that .env to the folder's .gitignore. It refuses a folder that
+ * is in a project already (here or above) — but for a project with no source file (one an older Mason made), whose
+ * source file it writes, nothing else changed.
+ *
+ * `mason init demo` (src/cli/demo.ts) writes the same files for a database Mason hosts itself: the demo's URL, on a port
+ * free now, in `.env` (the one place the port is kept), three of the demo's four tables already added (the fourth,
+ * `DEMO_TABLE_TO_ADD`, left for the person's first `mason add`), and `demo: true` in the config; there is nothing to
+ * connect to yet — `mason start` makes the database in `.mason/demo/`.
  */
 import * as fs from "node:fs";
 import * as path from "node:path";
@@ -22,41 +30,58 @@ import { cliPinProblem, ensurePin } from "./pin.js";
 import { version } from "./version.js";
 import { parseVersion, PIN_FILE } from "../lib/project-version.js";
 import { appDatabaseUrl, appEnvValue, appendEnvLine, ENV_FILE } from "../lib/dotenv.js";
-import { NAME_RE, STATE_DIR, brokenProblem, findProject, ignoresStateDir, nameFromFolder, newConfig, writeConfig } from "./project.js";
+import { DEMO_DIR, NAME_RE, STATE_DIR, brokenProblem, findProject, ignoresStateDir, nameFromFolder, newConfig, writeConfig } from "./project.js";
+import { DEMO_ADDED_TABLES, DEMO_ARG, DEMO_PORT, DEMO_SYNC, DEMO_TABLE_TO_ADD, demoUrl } from "./demo.js";
+import { freePort } from "./ports.js";
+import { databaseNameProblem, DEFAULT_DATABASE } from "../lib/database-name.js";
+import { DEFAULT_SYNC, syncText } from "../lib/table-sync.js";
+import { newRolesText, rolesFile } from "./roles.js";
 import { newSourceText, OLD_TABLES_DIR, parseSourceText, shownPath, sourceFileNames, sourceNameFor, sourcesDir } from "./sources.js";
-export const INIT_USAGE = `usage: mason init [<postgres url>] [--name <name>] [--folder <dir>] [--remote] [--skip-check] [--json]
+export const INIT_USAGE = `usage: mason init [<postgres url> | demo] [--name <name>] [--database <name>] [--folder <dir>] [--remote] [--skip-check] [--json]
 
   Makes this folder a Mason project — run it in your app's folder. It checks it can read the database (and writes
   nothing when it cannot), then creates:
-    .mason/                   this machine's: Mason's key and, once Mason runs, its copy and state (gitignored)
-    mason/sources/<db>.yml    the database and the tables to copy (mason add adds them) — commit it
+    .mason/                   this machine's: Mason's key and, once Mason runs, its synced data and state (gitignored)
+    mason/sources/<db>.yml    the database and the tables to sync (mason add adds them) — commit it
+    mason/roles.yml           who may read what: one role, everything (tables: all), the default of a user added
+                              without --role, so every user reads every synced table until you narrow it — commit it
     mason/mason.yml           the Mason version the project is written for — commit it: production runs that version
-  The source file says url: \${DATABASE_URL}: the URL itself is in .env (written there when you give it here or it is
-  only in the shell), never in a committed file. .mason/ and that .env go into .gitignore. Every other mason command
-  then works anywhere in this folder. In a project with no source file (an older Mason's), it writes that file alone.
+  With no URL it reads MASON_DATABASE_URL, else your app's DATABASE_URL, each from .env.local, then .env, then the
+  shell. The source file names the variable read, url: \${DATABASE_URL} — \${MASON_DATABASE_URL} when that is the one
+  read, or when a URL given here is another database than your app's DATABASE_URL: the URL itself is in .env (written
+  there when you give it here or it is only in the shell), never in a committed file. .mason/ and that .env go into
+  .gitignore. Every other mason command then works anywhere in this folder. A source file already here (a clone of the
+  project) is kept, and a bare mason init reads the variable it names; a roles file already here is kept. In a project
+  with no source file (an older Mason's), it writes that file alone, and the roles file when there is none.
+  mason init demo, in a new folder, makes a project on a demo database Mason hosts itself (a shop: customers, products,
+  orders, order_items): mason start makes it in .mason/demo/ and changes it every few seconds. Three of its tables are
+  added; the fourth is yours to add after mason start (mason add ${DEMO_TABLE_TO_ADD}), to watch its first sync begin.
 
-    mason init                                          DATABASE_URL from .env.local, .env or the shell
+    mason init                                          MASON_DATABASE_URL, else DATABASE_URL (.env or the shell)
     mason init postgres://me:secret@localhost:5432/shop
+    mason init demo                                     a demo database Mason hosts itself: nothing to install
     mason init --folder db/mason --name shop-admin      the project's files elsewhere; another name
     mason init postgres://me:secret@db.example.com/shop --remote
 
-  --name <name>     the project's name: the database name a tool connects to on the Postgres API (default: this folder's)
+  --name <name>     the project's name, which its replication slot is named for (default: this folder's)
+  --database <name> the database name a tool connects with, written as database: in the source file (default: none
+                    written, so tools connect with ${DEFAULT_DATABASE}): your database's own, and a tool keeps the name it has
   --folder <dir>    where sources/ goes, relative to this folder (default mason; . for this folder itself)
-  --remote          go ahead with a database on another machine (read the warnings mason init prints)
-  --skip-check      write the project without connecting (the database is not up yet); mason start checks it
-  --json            as data: { name, root, folder, config, source: { name (the source's: its file's), file, url (as the
-                    file writes it), env (the .env line
-                    written, its value masked, or null) }, database: { url (password masked), from, version, tables },
-                    warnings, next }
+  --remote          go ahead with a database on another machine (read the warnings mason init prints); not with demo
+  --skip-check      write the project without connecting (the database is not up yet); mason start checks it; not with demo
+  --json            as data: { name, root, folder, config, demo (true for the demo database's project, else false),
+                    source: { name (the source's: its file's), file, url (as the file writes it), database (the name
+                    a tool connects with, or null when the file has a mistake), env (the .env line written, its value masked, or null) }, roles: { file, written (false: one was here, and kept) },
+                    database: { url (password masked), from, version, tables }, warnings, next }
 `;
 export const INIT = {
     name: "init",
-    summary: "make this folder a Mason project on your Postgres: mason init (DATABASE_URL from .env) or mason init postgres://…",
+    summary: "make this folder a Mason project on your Postgres: mason init (its URL from .env), mason init postgres://… or demo",
     usage: INIT_USAGE,
-    options: { name: { type: "string" }, folder: { type: "string" }, remote: { type: "boolean" }, "skip-check": { type: "boolean" }, json: { type: "boolean" } },
-    json: ["name", "root", "folder", "config", "source", "database", "warnings", "next"],
+    options: { name: { type: "string" }, database: { type: "string" }, folder: { type: "string" }, remote: { type: "boolean" }, "skip-check": { type: "boolean" }, json: { type: "boolean" } },
+    json: ["name", "root", "folder", "config", "demo", "source", "roles", "database", "warnings", "next"],
 };
-/** Why `name` cannot be this project's, or null: not a name the Postgres API's database and the slot take. */
+/** Why `name` cannot be this project's, or null: not a name its replication slot takes. */
 export function nameProblem(name) {
     if (!NAME_RE.test(name))
         return `${JSON.stringify(name)} is not a project name: lower-case letters, digits, - and _, starting with a letter or digit (--name sets it)`;
@@ -74,7 +99,7 @@ export function withIgnored(gitignore, files = []) {
     let tail = "";
     if (!ignoresStateDir(text)) {
         added.push(`${STATE_DIR}/`);
-        tail += `# Mason: this machine's key, copy and state (mason init)\n${STATE_DIR}/\n`;
+        tail += `# Mason: this machine's key, synced data and state (mason init)\n${STATE_DIR}/\n`;
     }
     for (const f of files)
         if (!ignoresFile(text, f)) {
@@ -112,8 +137,13 @@ export function committedInGit(root, file) {
  * when the folder's .env.local or .env gives it already. DATABASE_URL when the folder's files give it no other value
  * (one only in the shell is written down: the next shell may not have it); else MASON_DATABASE_URL, so the app's own
  * DATABASE_URL is never changed under it. A problem when both name other databases.
+ * A URL READ FROM A VARIABLE (`found`, a bare mason init's `appDatabaseUrl`) is kept in that variable: the one read is
+ * the one named, and nothing is written when a folder's file gave it — so a MASON_DATABASE_URL is never written again as
+ * DATABASE_URL; one only in the shell is written down under its own name.
  */
-export function urlVariable(root, url) {
+export function urlVariable(root, url, found = null) {
+    if (found !== null)
+        return { variable: found.variable, line: found.file === null ? `${found.variable}=${url}` : null };
     for (const variable of ["DATABASE_URL", "MASON_DATABASE_URL"]) {
         const inFiles = appEnvValue(root, variable, {});
         if (inFiles === null)
@@ -121,10 +151,10 @@ export function urlVariable(root, url) {
         if (inFiles.value === url)
             return { variable, line: null };
     }
-    return { problem: "this folder's .env names DATABASE_URL and MASON_DATABASE_URL for other databases: set one of them to the database Mason copies from, then mason init again" };
+    return { problem: "this folder's .env names DATABASE_URL and MASON_DATABASE_URL for other databases: set one of them to the database Mason syncs from, then mason init again" };
 }
 /** `.env` with `line` added (made when there is none). */
-const addEnvLine = (root, line) => appendEnvLine(root, line, "the database Mason copies from (mason/sources/ names it; never commit this file)");
+const addEnvLine = (root, line) => appendEnvLine(root, line, "the database Mason syncs from (mason/sources/ names it; never commit this file)");
 /** A `.env` line as it is said: its value's password masked. */
 const maskedLine = (line) => { const eq = line.indexOf("="); return `${line.slice(0, eq)}=${maskedUrl(line.slice(eq + 1))}`; };
 export async function init(argv, cwd = process.cwd(), deps = {}) {
@@ -137,6 +167,14 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
     const usage = (message, fix) => failed("init", { message, code: "usage", fix }, { json, io });
     if (f.positionals.length > 1)
         return failed("init", { message: "one postgres:// URL at most", code: "usage", usage: INIT_USAGE }, { json, io });
+    // THE DEMO (src/cli/demo.ts): a database Mason hosts, made by mason start; there is nothing to check, nor elsewhere
+    const demo = f.positionals[0] === DEMO_ARG;
+    if (demo) {
+        for (const flag of ["remote", "skip-check"]) {
+            if (f.values[flag] === true)
+                return failed("init", { message: `--${flag} means nothing for the demo database: it is on this machine, made and hosted by mason start`, code: "usage", fix: "mason init demo, without it", usage: INIT_USAGE }, { json, io });
+        }
+    }
     let root = path.resolve(cwd);
     const existing = findProject(root);
     // a project whose config cannot be read is still this folder's: a second init over it would hide the first's data
@@ -155,6 +193,10 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
         return failed("init", { message: `${existing.root === root ? "this folder is" : `this folder is inside ${existing.root}, which is`} already the Mason project ${existing.config.name}`, code: "refused",
             fix: `to point it at another database, ${where}`, next: [["mason status", "what it is doing"]] }, { json, io });
     }
+    if (sourceless && demo) {
+        return failed("init", { message: `this folder is the Mason project ${sourceless.config.name} already: mason init demo makes a project of its own`, code: "refused",
+            fix: "run it in a new folder (mkdir mason-demo && cd mason-demo && mason init demo)", next: [["mason init", "this project's source file, on your database"]] }, { json, io });
+    }
     if (sourceless && (f.values.name !== undefined || f.values.folder !== undefined)) {
         return usage(`this folder is the Mason project ${sourceless.config.name} already, whose source file is all mason init writes here: it takes no --name or --folder`, "mason init [<postgres url>], in the project's folder");
     }
@@ -170,33 +212,65 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
     const named = nameProblem(name);
     if (named)
         return usage(named);
-    let url = f.positionals[0] ?? null;
+    const connectName = f.values.database ?? null;
+    const badDatabase = connectName === null ? null : databaseNameProblem(connectName);
+    if (badDatabase !== null)
+        return usage(`--database: ${badDatabase}`);
+    // THE SOURCE FILE: one already here (a clone of the project) is kept; else written, its URL a variable of .env
+    const kept = sourceFileNames(folder)[0] ?? null;
+    if (demo && kept !== null) {
+        // a clone's sources file names the team's database: the demo never takes its place
+        return failed("init", { message: `${path.relative(root, path.join(sourcesDir(folder), kept))} is already here: mason init demo makes a project of its own`, code: "refused",
+            fix: "run it in a new folder (mkdir mason-demo && cd mason-demo && mason init demo), or mason init here for the database that file names" }, { json, io });
+    }
+    const keptPath = kept === null ? null : path.join(sourcesDir(folder), kept);
+    if (connectName !== null && keptPath !== null)
+        return usage(`--database writes a new source file, and ${path.relative(root, keptPath)} is here already`, `write database: ${connectName} in it`);
+    const keptFile = kept === null || keptPath === null ? null : parseSourceText(fs.readFileSync(keptPath, "utf8"), kept.replace(/\.ya?ml$/, ""), keptPath);
+    const keptVar = keptFile !== null && !("problems" in keptFile) && "env" in keptFile.url ? keptFile.url.env : null;
+    // the demo's URL names a port free now, and is the one place the port is kept: mason start reads it from there
+    let url = demo ? demoUrl(await freePort(DEMO_PORT)) : f.positionals[0] ?? null;
     let from = "";
     let envFile = null; // the folder's file the URL was read from (.env.local or .env): ignored with .mason/
+    let envVariable = null; // the variable envFile holds the URL in, set with it: the warning names it
+    // the variable a bare mason init read the URL from: the one the sources file names (urlVariable)
+    let found = null;
     if (url === null) {
-        const found = appDatabaseUrl(root);
+        // THE KEPT FILE DECIDES WHAT IS READ: the variable its url: names, as the run reads it (.env.local, .env, the shell),
+        // so the database init checks is the one mason start copies from; MASON_DATABASE_URL, then DATABASE_URL, only when
+        // no kept file names one (a clone naming DATABASE_URL was checked against a MASON_DATABASE_URL in the shell)
+        if (keptVar !== null && keptPath !== null) {
+            const v = appEnvValue(root, keptVar, deps.env ?? process.env);
+            const file = shownPath(root, keptPath);
+            if (v === null) {
+                return failed("init", { message: `which database? ${file} names url: \${${keptVar}}, and this folder has no ${keptVar}`, code: "usage",
+                    why: `mason start reads the URL from ${keptVar}, so mason init checks that one`,
+                    fix: `put it in this folder's .env as ${keptVar}=postgres://… (the variable ${file} names), or give its URL on the command line: mason init writes it there`,
+                    next: [["mason init postgres://user:password@localhost:5432/your_app", `its URL, given: written to .env as ${keptVar}`], ["mason init", `again, once .env has ${keptVar}`]] }, { json, io });
+            }
+            found = { url: v.value, variable: keptVar, from: `${keptVar} in ${v.from}`, file: v.file };
+        }
+        else
+            found = appDatabaseUrl(root, deps.env ?? process.env);
         if (!found) {
-            // the two fixes ARE the next commands, so a coding agent reads them as such too
-            return failed("init", { message: "which database? none is named, and this folder has no DATABASE_URL", code: "usage",
-                fix: "give its URL on the command line, or put it in this folder's .env as DATABASE_URL=postgres://… (your app's, usually)",
-                next: [["mason init postgres://user:password@localhost:5432/your_app", "its URL, given"], ["mason init", "again, once .env has DATABASE_URL"]] }, { json, io });
+            // the fixes ARE the next commands, so a coding agent reads them as such too
+            return failed("init", { message: "which database? none is named, and this folder has no MASON_DATABASE_URL or DATABASE_URL", code: "usage",
+                fix: "give its URL on the command line, or put it in this folder's .env as DATABASE_URL=postgres://… (your app's, usually) or as MASON_DATABASE_URL=postgres://… (read first: a database other than your app's)",
+                next: [["mason init postgres://user:password@localhost:5432/your_app", "its URL, given"], ["mason init", "again, once .env has MASON_DATABASE_URL or DATABASE_URL"],
+                    ["mason init demo", "a demo database Mason makes itself: nothing to install"]] }, { json, io });
         }
         url = found.url;
-        from = ` (DATABASE_URL in ${found.from})`;
+        from = ` (${found.from})`;
         envFile = found.file;
+        envVariable = found.variable;
     }
     const parsed = parseSource(url);
     if ("problem" in parsed)
         return usage(parsed.problem);
     const remote = f.values.remote === true || sourceless?.config.remote === true;
-    // THE SOURCE FILE: one already here (a clone of the project) is kept; else written, its URL a variable of .env
-    const kept = sourceFileNames(folder)[0] ?? null;
-    const keptText = kept === null ? null : fs.readFileSync(path.join(sourcesDir(folder), kept), "utf8");
-    const keptFile = kept === null ? null : parseSourceText(keptText, kept.replace(/\.ya?ml$/, ""), path.join(sourcesDir(folder), kept));
-    const keptVar = keptFile !== null && !("problems" in keptFile) && "env" in keptFile.url ? keptFile.url.env : null;
     // a kept file's variable gets this URL in .env when the folder's files give it none; one they give another value is said
     const keptValue = keptVar === null ? null : appEnvValue(root, keptVar, {});
-    const where = kept === null ? urlVariable(root, url)
+    const where = kept === null ? urlVariable(root, url, found)
         : { variable: keptVar ?? "", line: keptVar !== null && keptValue === null ? `${keptVar}=${url}` : null };
     if ("problem" in where)
         return failed("init", { message: where.problem, code: "refused" }, { json, io });
@@ -211,10 +285,12 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
     line(st.bold(`Making ${name} a Mason project in ${root}`));
     const notes = [];
     if (keptValue !== null && keptValue.value !== url)
-        notes.push(`${kept} reads ${keptVar} from ${keptValue.from}, which is ${maskedUrl(keptValue.value)}: mason start copies from that one, not ${db}`);
+        notes.push(`${kept} reads ${keptVar} from ${keptValue.from}, which is ${maskedUrl(keptValue.value)}: mason start syncs from that one, not ${db}`);
     let database = { url: db, from: from ? from.slice(2, -1) : null, version: null, tables: null };
     const rel = (p) => path.relative(root, p) || ".";
     const sourceFile = kept !== null ? path.join(sourcesDir(folder), kept) : path.join(sourcesDir(folder), `${sourceNameFor(parsed.source.database)}.yml`);
+    const rolesPath = rolesFile(folder);
+    const rolesKept = fs.existsSync(rolesPath);
     // the folder an older Mason listed the tables in: read by nothing (no backwards compatibility before v1.0), said
     const oldTables = path.join(folder, OLD_TABLES_DIR);
     if (fs.existsSync(oldTables))
@@ -222,10 +298,14 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
     // A DATABASE ON ANOTHER MACHINE, NOT CONFIRMED: not a failed step (the check passed, or was skipped) but a stop before
     // anything is written, said as one failure (remoteConfirmation) — the same words whether the check ran or not
     const confirmRemote = () => failed("init", remoteConfirmation(parsed.source.host, { cmd: "mason init",
-        wayOut: "run the same mason init again with --remote: that says yes, copy from that machine",
+        wayOut: "run the same mason init again with --remote: that says yes, sync from that machine",
         next: [["mason init --remote <url>", "the same command, confirmed"]] }), { json, io });
     try {
-        if (f.values["skip-check"] === true) {
+        if (demo) {
+            // nothing exists yet: mason start makes the database (src/demo/source.ts) at its first start
+            await steps.step("Choosing the demo database's port", () => null, () => `The demo database will be ${db}: mason start makes it in ${STATE_DIR}/${DEMO_DIR}/ and seeds it (nothing to connect to yet)`);
+        }
+        else if (f.values["skip-check"] === true) {
             if (parsed.source.remote && !remote)
                 return confirmRemote();
             await steps.step(`Not checking ${db}${from}`, () => null, () => `Not checking ${db}${from} (--skip-check): mason start checks it`);
@@ -254,27 +334,40 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
             database = { ...database, version: checked.facts.versionText, tables: checked.facts.tables.length };
         }
         if (sourceless)
-            await steps.step(`Keeping ${STATE_DIR}/config.json`, () => undefined, () => `Kept ${STATE_DIR}/config.json: the project ${name}, its key and its copy`);
+            await steps.step(`Keeping ${STATE_DIR}/config.json`, () => undefined, () => `Kept ${STATE_DIR}/config.json: the project ${name}, its key and its synced data`);
         else {
             await steps.step(`Writing ${STATE_DIR}/config.json`, () => {
-                writeConfig(path.join(root, STATE_DIR), newConfig(name, path.relative(root, folder) || ".", remote));
+                writeConfig(path.join(root, STATE_DIR), newConfig(name, path.relative(root, folder) || ".", remote, { demo }));
             }, () => `Wrote ${STATE_DIR}/config.json: Mason's key (this machine's)`);
         }
         if (kept !== null) {
-            await steps.step(`Keeping ${rel(sourceFile)}`, () => undefined, () => `Kept ${rel(sourceFile)}: the database and the tables this project copies`);
+            await steps.step(`Keeping ${rel(sourceFile)}`, () => undefined, () => `Kept ${rel(sourceFile)}: the database and the tables this project syncs`);
             if (keptFile !== null && "problems" in keptFile)
                 notes.push(`${rel(sourceFile)} has ${keptFile.problems.length === 1 ? "a mistake" : "mistakes"}, which mason start refuses: ${keptFile.problems.join("; ")}`);
         }
         else {
             await steps.step(`Writing ${rel(sourceFile)}`, () => {
                 fs.mkdirSync(path.dirname(sourceFile), { recursive: true });
-                fs.writeFileSync(sourceFile, newSourceText(`\${${where.variable}}`));
-            }, () => `Wrote ${rel(sourceFile)}: the database (url: \${${where.variable}}) and the tables to copy, none yet (mason add) — commit it`);
+                fs.writeFileSync(sourceFile, newSourceText(`\${${where.variable}}`, demo ? DEMO_ADDED_TABLES : [], demo ? DEMO_SYNC : DEFAULT_SYNC, connectName));
+            }, () => `Wrote ${rel(sourceFile)}: the database (url: \${${where.variable}}), ${connectName === null ? "" : `database: ${connectName}, `}sync: ${syncText(demo ? DEMO_SYNC : DEFAULT_SYNC)} ` +
+                `(${demo ? "every table polled every 5 s" : "each table read once, then again only by mason sync <table>"}) and the tables to sync, ` +
+                `${demo ? `the demo's ${DEMO_ADDED_TABLES.length} added — mason add ${DEMO_TABLE_TO_ADD} adds the fourth` : "none yet (mason add)"} — commit it`);
+        }
+        // THE ROLES FILE (src/cli/roles.ts newRolesText): today's access said in a committed file — every user reads every
+        // copied table, as the default role everything — kept when one is here (a clone of the project)
+        if (rolesKept)
+            await steps.step(`Keeping ${rel(rolesPath)}`, () => undefined, () => `Kept ${rel(rolesPath)}: the roles and the default for a user added without --role`);
+        else {
+            await steps.step(`Writing ${rel(rolesPath)}`, () => {
+                fs.mkdirSync(path.dirname(rolesPath), { recursive: true });
+                fs.writeFileSync(rolesPath, newRolesText());
+            }, () => `Wrote ${rel(rolesPath)}: every user reads every synced table (default: everything, tables: all) — narrow it with a second role — commit it`);
         }
         if (where.line !== null) {
             const envLine = where.line;
             await steps.step(`Writing ${where.variable} to .env`, () => addEnvLine(root, envLine), () => `Wrote ${maskedLine(envLine)} to .env: the URL the source file names, kept out of git`);
             envFile = ENV_FILE;
+            envVariable = where.variable;
         }
         // THE VERSION PIN (src/cli/pin.ts): what production's image is held to. A checkout's mason (`dev`) has none to write
         const cli = deps.version ?? version();
@@ -295,7 +388,7 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
             return after === null ? "already" : before === null ? "made" : after.added.join(" and ");
         }, (r) => r === "already" ? `.gitignore already ignores ${ignored}` : r === "made" ? `Made .gitignore, ignoring ${ignored}` : `Added ${r} to .gitignore`);
         if (envFile && committedInGit(root, envFile)) {
-            notes.push(`${envFile} holds the database URL (DATABASE_URL) and is committed in git: git rm --cached ${envFile} takes it out of the next commit (the file stays); then change the password`);
+            notes.push(`${envFile} holds the database URL (${envVariable}) and is committed in git: git rm --cached ${envFile} takes it out of the next commit (the file stays); then change the password`);
         }
     }
     catch (e) {
@@ -307,20 +400,28 @@ export async function init(argv, cwd = process.cwd(), deps = {}) {
         return failed("init", { message: first ?? e.message, code: e.exit === 2 ? "usage" : "failed", exit: e.exit, fix: rest.length ? rest.map((l) => l.replace(/^\s*- /, "")).join("\n") : undefined,
             why: parsed.source.remote ? undefined : `the database's URL is ${db}${from}` }, { json, io });
     }
-    const next = [
+    const next = demo ? [
+        ["mason start", "the demo database and Mason, in the background: its tables synced, then kept current"],
+        [`mason add ${DEMO_TABLE_TO_ADD}`, "the demo's fourth table, once Mason is up: watch its first sync begin"],
+        ["mason status", "the synced data keeping up with the demo's changes"],
+        ["mason user add <name>", "a user for psql or a BI tool: its password and URL, printed once"],
+    ] : [
         ["mason start", "Mason in the background, for this folder"],
         ["mason tables", "the database's tables and their columns"],
-        ["mason add <table>", "copy a table into Mason"],
+        ["mason add <table>", "sync a table into Mason"],
     ];
     if (json) {
-        say(jsonText(INIT, { name, root, folder: path.relative(root, folder) || ".", config: path.join(root, STATE_DIR, "config.json"),
+        say(jsonText(INIT, { name, root, folder: path.relative(root, folder) || ".", config: path.join(root, STATE_DIR, "config.json"), demo,
             source: { name: path.basename(sourceFile).replace(/\.ya?ml$/, ""), file: sourceFile, url: keptFile !== null && !("problems" in keptFile) ? ("env" in keptFile.url ? `\${${keptFile.url.env}}` : maskedUrl(keptFile.url.literal)) : `\${${where.variable}}`,
+                database: keptFile === null ? connectName ?? DEFAULT_DATABASE : "problems" in keptFile ? null : keptFile.database ?? DEFAULT_DATABASE,
                 env: where.line === null ? null : maskedLine(where.line) },
+            roles: { file: rolesPath, written: !rolesKept },
             database, warnings: notes }, next));
         return 0;
     }
     for (const n of notes)
         say(`  ! ${n}`);
-    say(endText({ tips: ["Mason only reads your database: no setting, slot or publication is needed or made"], next }, st));
+    say(endText({ tips: [demo ? `The demo database runs inside mason start, read by polling: a new order every few seconds; ${DEMO_TABLE_TO_ADD} is left for you to add; mason destroy removes it with the synced data`
+                : "Mason only reads your database: no setting, slot or publication is needed or made"], next }, st));
     return 0;
 }

package/dist/src/cli/machine.js

@@ -18,15 +18,16 @@ import { dropOwnReplication, dropStatements, madeReplication } from "./replicati
 import { sourceFileNames } from "./sources.js";
 export const DESTROY_USAGE = `usage: mason destroy [--json]
 
-  Removes this folder's project's copy of your data from this machine — its file — and Mason's state in its
+  Removes this folder's project's synced data from this machine — its file — and Mason's state in its
   .mason/ (the logs, the request log). Mason is stopped first if it runs. Your files (mason/sources/), .mason/config.json and
-  the users (mason user) stay: the next mason start copies the tables again, and every tool connects as before.
+  the users (mason user) stay: the next mason start syncs the tables again, and every tool connects as before.
 
     mason destroy                this folder's project
 
-  mason stop keeps the copy and the state, and the next mason start resumes in seconds; mason destroy frees the disk, and
+  mason stop keeps the synced data and the state, and the next mason start resumes in seconds; mason destroy frees the disk, and
   the next mason start begins again. In replication mode the slot (and Mason's own publication) are dropped from the
-  database too: they hold its WAL for as long as they exist.
+  database too: they hold its WAL for as long as they exist. A demo project's database (mason init demo, in .mason/demo/)
+  goes with the synced data: the next mason start makes and seeds it again.
 
   --json   as data: { removed: [{ name, removed: [what], error }], next }
 
@@ -35,7 +36,7 @@ export const DESTROY_USAGE = `usage: mason destroy [--json]
 export const DESTROY = {
     needs: "project",
     name: "destroy",
-    summary: "remove this project's copy of the data and Mason's state from this machine (your files and users stay)",
+    summary: "remove this project's synced data and Mason's state from this machine (your files and users stay)",
     usage: DESTROY_USAGE,
     options: { json: { type: "boolean" } },
     json: ["removed", "next"],
@@ -70,11 +71,12 @@ export async function removeProject(p, o = {}) {
         if (sup !== null)
             removed.push(`stopped its supervisor (pid ${sup}), which was about to start it again`);
     }
-    // REPLICATION MODE made a publication and a slot on the database (src/cli/replication-mode.ts): the slot holds its WAL
-    // for as long as it exists, so it goes with the copy — and when it cannot, the rest goes and the failure says how
+    // REPLICATION made a publication and a slot on the database (src/cli/replication-mode.ts), recorded by the start or
+    // the run that made them (an older start recorded its mode, `changes`): the slot holds its WAL for as long as it
+    // exists, so it goes with the copy — and when it cannot, the rest goes and the failure says how
     let replication = null;
     let objects = "publication and replication slot";
-    if (p.config.changes === "replication") {
+    if ((p.config.replication ?? null) !== null || p.config.changes === "replication") {
         // the slot, and the publication only when it is Mason's own: one the operator named is its owner's, left as it is
         const src = projectSource(p);
         // what the start that made them recorded (madeReplication); a project with no record names them by its one sources file
@@ -89,7 +91,7 @@ export async function removeProject(p, o = {}) {
             // and the real slot goes on holding its WAL (the review of the sources file)
             const from = p.config.sourceServer ?? null;
             if (from !== null && from.database !== parsed.source.database) {
-                throw new Error(`the sources file names ${parsed.source.database} now, and the copy came from ${from.database}, where the slot is: ` +
+                throw new Error(`the sources file names ${parsed.source.database} now, and the synced data came from ${from.database}, where the slot is: ` +
                     `put that database's URL back in the sources file and run mason destroy again, or drop them on ${from.database} by hand`);
             }
             for (const d of await (o.dropReplication ?? dropOwnReplication)(parsed.source, own, from))
@@ -101,7 +103,9 @@ export async function removeProject(p, o = {}) {
     }
     // the users (src/duck/users.ts) are logins a BI tool keeps, like the API key their passwords are made with, and the
     // self-signed certificate is the fingerprint a tool pinned (the review of the cut: a new one at the next
-    // start, and config.selfSignedTls stale): the next start copies again, and every tool connects as before
+    // start, and config.selfSignedTls stale): the next start copies again, and every tool connects as before. A demo
+    // project's database (`.mason/demo/`, src/cli/demo.ts) is state like the copy: it goes, and config.demo stays, so the
+    // next start makes and seeds it again
     const kept = new Set(["config.json", USERS_FILE, SELF_SIGNED_FILES.cert, SELF_SIGNED_FILES.key]);
     const gone = fs.existsSync(p.dir) ? fs.readdirSync(p.dir).filter((x) => !kept.has(x)) : [];
     for (const x of gone)
@@ -142,7 +146,7 @@ export async function destroy(argv, deps = {}) {
     catch (e) {
         result = { name, removed: [], error: e.message };
     }
-    const next = result.error ? [] : [["mason start", "copies the tables again"]];
+    const next = result.error ? [] : [["mason start", "syncs the tables again"]];
     if (json) {
         out(jsonText(DESTROY, { removed: [result] }, next));
         return result.error ? 1 : 0;
@@ -151,7 +155,9 @@ export async function destroy(argv, deps = {}) {
         return failed("destroy", { message: `${name}: ${result.error}`, code: "failed" }, { json: false, io });
     out(withEnd(reportText({
         headline: result.removed.length ? `Removed ${name}` : `Nothing was left of ${name} to remove`,
-        details: [...(result.removed.length ? [["removed", result.removed.join(", ")]] : []), ["kept", `your files in ${t.project.folder}, .mason/config.json and the users`]],
+        details: [...(result.removed.length ? [["removed", result.removed.join(", ")]] : []), ["kept", `your files in ${t.project.folder}, .mason/config.json and the users` +
+                    // the demo database is state like the copy (src/cli/demo.ts): it goes, and config.demo stays to make it again
+                    (t.project.config.demo === true ? ` — not the demo database, which went with the synced data: the next mason start seeds it again` : "")]],
     }), { next }));
     return 0;
 }

package/dist/src/cli/main.js

@@ -32,17 +32,17 @@ async function main(argv) {
         return 0;
     }
     const cmd = COMMANDS.find((c) => c.name === command);
-    const json = wantsJson(args);
+    const json = wantsJson(args, cmd);
     // the commands' old names: said, never run as different ones
     const RENAMED = {
         dev: { message: "mason dev is now mason start", next: [["mason init <postgres url>", "once, in your app's folder"], ["mason start", "Mason in the background"]] },
         docs: { message: "mason docs is now mason help", next: [["mason help agent", "driving Mason from a coding agent"], ["mason help production", "running Mason on a server"]] },
         // named for what it does to the copy, never for the mechanism
-        poll: { message: "mason poll is now mason sync", next: [["mason sync <table>", "make the copy of a table current now"], ["mason status", "each table's copy, and which the sync leaves out"]] },
-        purge: { message: "mason purge is now mason destroy", next: [["mason destroy", "this folder's project: its copy and state, never its files"]] },
+        poll: { message: "mason poll is now mason sync", next: [["mason sync <table>", "bring a synced table up to date now"], ["mason status", "each synced table, and which the sync leaves out"]] },
+        purge: { message: "mason purge is now mason destroy", next: [["mason destroy", "this folder's project: its synced data and state, never its files"]] },
         // mason rm read as the opposite of mason add: it removed a project's copy and state, never a table;
         // the opposite of mason add is mason remove, so both are offered
-        rm: { message: "mason rm is gone: mason remove takes a table out of the project, mason destroy removes the project's copy", next: [["mason remove <table>", "a table, and its copy"], ["mason destroy", "this folder's project: its copy and state, never its files"]] },
+        rm: { message: "mason rm is gone: mason remove takes a table out of the project, mason destroy removes the project's synced data", next: [["mason remove <table>", "a table, and its synced data"], ["mason destroy", "this folder's project: its synced data and state, never its files"]] },
         // a user's password does not expire, so mason user is enough and mason connect was dropped
         connect: { message: "mason connect is gone: mason user add <name> makes a user whose password does not expire, and prints the URL to paste", next: [["mason user add <name>", "a user for a BI tool or your app"], ["mason status", "where the Postgres API listens"]] },
         // a project is its folder (mason list was dropped): nothing on the machine lists them
@@ -76,7 +76,7 @@ main(process.argv.slice(2)).then(exitWhenWritten, (e) => {
     // MASON_DEBUG=1 prints where it happened, for the bug report it deserves. The same shape as every failure, JSON under --json.
     const message = e instanceof Error ? e.message : String(e);
     const [command, ...args] = process.argv.slice(2);
-    const code = failed(command ?? "", { message, code: "failed", fix: process.env.MASON_DEBUG ? undefined : "this is a bug in mason: MASON_DEBUG=1 prints where it happened, for the report" }, { json: wantsJson(args) });
+    const code = failed(command ?? "", { message, code: "failed", fix: process.env.MASON_DEBUG ? undefined : "this is a bug in mason: MASON_DEBUG=1 prints where it happened, for the report" }, { json: wantsJson(args, COMMANDS.find((c) => c.name === command)) });
     if (process.env.MASON_DEBUG)
         process.stderr.write(`${e.stack ?? ""}\n`);
     exitWhenWritten(code);