@codenotch/codenotch.cli 1.0.41 → 1.0.43

package/README.md

@@ -1,28 +1,78 @@
-# Getting started
-To use the commands `codenotch-cli` or `cn`
-
-`npm run build`
-`npm link`
-
-When there is a change, you need to relaunch `npm run build`
-
-## Runtime
-The CLI will automatically download the latest version runtime the first time it's needed or anytime `cn runtime install` or `cn runtime update` is used.
-Since the package is private at the moment, you'll need to login via an interactive browser prompt.
-
-By default the CLI installs the runtime in a `.codenotch` folder in the user home directory ($HOME / USERPROFILE).
-This behaviour can be changed by setting `CODENOTCH_PATH` in the .env file.
-
-### Manual install
-You can also get the runtime manually here: https://github.com/EchinoHub/service-core/releases/
-Then you can either find/create a `.codenotch` in your home directory or set the `CODENOTCH_PATH` to where you put the runtime.
-
-### Runtime requirements
-You need to have NodeJs installed and available on the PATH for the runtime to work properly.
-
-
-## .npmrc
-We need a npm token to get the private package @codenotch/codenotch.react from npm.
-At the moment we use a npm file that we copy on build to the project.
-This token is not valid to get others private packages, meaning it will also prevent you from installing other codenotch packages
-We need to fin a real solution to this or simply make the @codenotch/codenotch.reactpackage public
+# Codenotch CLI
+
+`cn`, the command line of the [Codenotch](https://codenotch.com/) platform: scaffold, run,
+validate, package and deploy full-stack TypeScript projects — server-side processes, SQL tables,
+NoSQL documents and React 19 apps — on a Codenotch runtime.
+
+> The website is not up to date. The reference documentation ships with this CLI: run `cn docs`.
+
+## Install
+
+```sh
+npm install -g @codenotch/codenotch.cli
+```
+
+Requires Node.js 20+. This gives you the `cn` command (long form: `codenotch-cli`).
+
+## Getting started
+
+```sh
+cn runtime update      # install (or update) the local Codenotch runtime
+cn runtime start       # start it
+cn project new         # create a project (asks for the template and the name)
+cn project start       # build, deploy and open it
+```
+
+`cn project new` offers four templates:
+
+| Template | What you get |
+| --- | --- |
+| `default` | Empty project with a routed React 19 app |
+| `tailwind` | Same, styled with Tailwind CSS 4 (light and dark themes) |
+| `todolist` | Complete todo list app: tables, CRUD processes, queries, translations |
+| `api` | API only: a table and its endpoints, no app at all |
+
+## What a project is
+
+A Codenotch project is TypeScript end to end, and the CLI discovers what it declares by parsing
+the sources — there is no registry to maintain:
+
+- **processes** — `process({...})` declarations exposed as API endpoints, timers or signals;
+- **tables and documents** — `defineEntity({...})` / `defineDocument({...})`, from which the
+  database schema and the typed data access are generated;
+- **queries** — `.cnql` read queries the processes run;
+- **apps** — React 19 components, built and dev-served with Vite;
+- **translations** — `*.i18n.csv` files turned into typed classes.
+
+Run `cn docs` for the reference of each of these, matching the installed CLI version.
+
+## Everyday commands
+
+| Command | What it does |
+| --- | --- |
+| `cn project start` | build, deploy and start the project on the local runtime |
+| `cn project refresh` | after a change: sync the project with the running runtime |
+| `cn project inspect` | parse the project and display everything the CLI discovered |
+| `cn validate .` | hints, warnings and errors of every file |
+| `cn generate ...` | derived files (db schema, openapi, i18n classes) and scaffolds (apps, model processes) |
+| `cn react dev` | Vite dev server with hot reload for an app |
+| `cn project package` / `deploy` | ship a project as a zip to a runtime |
+
+Run `cn --help` (or `cn <command> --help`) for the complete list.
+
+## Built for AI coding agents
+
+Every generated project carries an `AGENTS.md` (and a `CLAUDE.md` importing it) telling coding
+agents how to work on it: the rules of the generated files, and where the reference lives —
+`cn docs <topic>` (project, tables, processes, queries, apps, i18n), so the documentation always
+matches the installed CLI. `cn validate`, `cn project inspect`, `cn runtime info` and `cn docs`
+take `--json` for machine-readable output.
+
+## Contributing
+
+See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for the development setup and
+[docs/ARCHITECTURE.md](docs/ARCHITECTURE.md) for the map of the code base.
+
+## License
+
+MIT

package/dist/commands/generate/dbcontext.js

@@ -13,7 +13,7 @@ const shared_1 = require("./shared");
 function registerGenerateDbContext(generate) {
     generate
         .command('dbcontext')
-        .description('Scan the tables of a project and generate its db-schema.xml + db-schema.ts')
+        .description('Scan the tables and documents of a project and generate its db-schema.xml + db-schema.d.ts')
         .requiredOption('-f, --project-path <path>', 'path to the project')
         .addHelpText('after', `
 Examples:
@@ -30,7 +30,7 @@ Examples:
         if (!(0, shared_1.reportGeneration)(result)) {
             return;
         }
-        ConsoleUtils_1.default.check(`${result.tableCount} table(s) scanned, schema written to ${chalk_1.default.green(result.written[0])} and ${chalk_1.default.green(result.written[1])}`);
+        ConsoleUtils_1.default.check(`${result.tableCount} table(s) and ${result.documentCount} document(s) scanned, schema written to ${chalk_1.default.green(result.written[0])} and ${chalk_1.default.green(result.written[1])}`);
     });
 }
 //# sourceMappingURL=dbcontext.js.map

package/dist/commands/generate/dbcontext.js.map

@@ -1 +1 @@
-{"version":3,"file":"dbcontext.js","sourceRoot":"","sources":["../../../src/commands/generate/dbcontext.ts"],"names":[],"mappings":";;;;;AAQA,8DA0BC;AAjCD,kDAA0B;AAC1B,+BAA+B;AAC/B,sEAA8C;AAC9C,4EAAoD;AACpD,8FAAsE;AACtE,qCAA4C;AAE5C,SAAgB,yBAAyB,CAAC,QAAiB;IACvD,QAAQ;SACH,OAAO,CAAC,WAAW,CAAC;SACpB,WAAW,CAAC,4EAA4E,CAAC;SACzF,cAAc,CAAC,2BAA2B,EAAE,qBAAqB,CAAC;SAClE,WAAW,CAAC,OAAO,EAAE;;;CAG7B,CAAC;SACO,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;QAE/C,MAAM,WAAW,GAAG,IAAA,cAAO,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEjD,IAAI,MAAM,mBAAS,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE,CAAC;YAChD,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,MAAM,CAAC,aAAa,WAAW,eAAe,CAAC,CAAC,CAAC;YACrE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,+BAAqB,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAA,yBAAgB,EAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,OAAO;QACX,CAAC;QAED,sBAAY,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,UAAU,wCAAwC,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAC3J,CAAC,CAAC,CAAC;AACX,CAAC"}
+{"version":3,"file":"dbcontext.js","sourceRoot":"","sources":["../../../src/commands/generate/dbcontext.ts"],"names":[],"mappings":";;;;;AAQA,8DA0BC;AAjCD,kDAA0B;AAC1B,+BAA+B;AAC/B,sEAA8C;AAC9C,4EAAoD;AACpD,8FAAsE;AACtE,qCAA4C;AAE5C,SAAgB,yBAAyB,CAAC,QAAiB;IACvD,QAAQ;SACH,OAAO,CAAC,WAAW,CAAC;SACpB,WAAW,CAAC,4FAA4F,CAAC;SACzG,cAAc,CAAC,2BAA2B,EAAE,qBAAqB,CAAC;SAClE,WAAW,CAAC,OAAO,EAAE;;;CAG7B,CAAC;SACO,MAAM,CAAC,KAAK,EAAE,OAAgC,EAAE,EAAE;QAE/C,MAAM,WAAW,GAAG,IAAA,cAAO,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAEjD,IAAI,MAAM,mBAAS,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,KAAK,EAAE,CAAC;YAChD,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,MAAM,CAAC,aAAa,WAAW,eAAe,CAAC,CAAC,CAAC;YACrE,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,+BAAqB,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC;QAC1E,IAAI,CAAC,IAAA,yBAAgB,EAAC,MAAM,CAAC,EAAE,CAAC;YAC5B,OAAO;QACX,CAAC;QAED,sBAAY,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,UAAU,iBAAiB,MAAM,CAAC,aAAa,2CAA2C,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,QAAQ,eAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IACnM,CAAC,CAAC,CAAC;AACX,CAAC"}

package/dist/commands/generate/index.js

@@ -17,7 +17,7 @@ function registerGenerateCommands(program) {
 Examples:
   $ cn generate app -n Dashboard        an empty React app and its manifest
   $ cn generate i18n                    regenerate the *.i18n.ts classes of the project
-  $ cn generate dbcontext -f .          db-schema.xml + db-schema.ts from the tables
+  $ cn generate dbcontext -f .          db-schema.xml + db-schema.d.ts from the tables and documents
   $ cn generate process -m api -t Book  REST endpoints working on a table
 `);
     (0, manifest_1.registerGenerateProjectManifest)(generate);

package/dist/commands/project/compile.js

@@ -5,20 +5,23 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerCompile = registerCompile;
 const chalk_1 = __importDefault(require("chalk"));
-const ProjectCompilationUtils_1 = __importDefault(require("../../utils/ProjectCompilationUtils"));
+const path_1 = __importDefault(require("path"));
+const ProjectUtils_1 = __importDefault(require("../../utils/ProjectUtils"));
 const shared_1 = require("./shared");
 function registerCompile(project) {
     (0, shared_1.withProjectPathOption)(project
         .command('compile')
-        .description('Compile the project, modify the source files in-place'))
+        .description('Compile the project into .codenotch/compiled, the sources are left untouched')
+        .option('-o, --output-path <path>', 'output folder for the compiled project (default .codenotch/compiled)'))
         .action(async (options) => {
-        const compilation = await ProjectCompilationUtils_1.default.compileProject(options.projectPath);
+        const outputPath = options.outputPath ?? path_1.default.join(options.projectPath, '.codenotch', 'compiled');
+        const compilation = await ProjectUtils_1.default.compileProjectTo(options.projectPath, outputPath);
         if (compilation.errors.length > 0) {
             console.error(chalk_1.default.red("Compilation failed with errors:"));
             compilation.errors.forEach(err => console.error(chalk_1.default.red(`- ${err}`)));
         }
         else {
-            console.log(chalk_1.default.green(`Project compiled successfully`));
+            console.log(chalk_1.default.green(`Project compiled successfully into ${outputPath}`));
         }
     });
 }

package/dist/commands/project/compile.js.map

@@ -1 +1 @@
-{"version":3,"file":"compile.js","sourceRoot":"","sources":["../../../src/commands/project/compile.ts"],"names":[],"mappings":";;;;;AAKA,0CAcC;AAlBD,kDAA0B;AAC1B,kGAA0E;AAC1E,qCAAyE;AAEzE,SAAgB,eAAe,CAAC,OAAgB;IAC5C,IAAA,8BAAqB,EAAC,OAAO;SACxB,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,uDAAuD,CAAC,CAAC;SACrE,MAAM,CAAC,KAAK,EAAE,OAA+B,EAAE,EAAE;QAC9C,MAAM,WAAW,GAAG,MAAM,iCAAuB,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACtF,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC,CAAC;YAC5D,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC;aACI,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC,CAAC;QAC9D,CAAC;IACL,CAAC,CAAC,CAAC;AACX,CAAC"}
+{"version":3,"file":"compile.js","sourceRoot":"","sources":["../../../src/commands/project/compile.ts"],"names":[],"mappings":";;;;;AAMA,0CAgBC;AArBD,kDAA0B;AAC1B,gDAAwB;AACxB,4EAAoD;AACpD,qCAAyE;AAEzE,SAAgB,eAAe,CAAC,OAAgB;IAC5C,IAAA,8BAAqB,EAAC,OAAO;SACxB,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,8EAA8E,CAAC;SAC3F,MAAM,CAAC,0BAA0B,EAAE,sEAAsE,CAAC,CAAC;SAC3G,MAAM,CAAC,KAAK,EAAE,OAAyD,EAAE,EAAE;QACxE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,YAAY,EAAE,UAAU,CAAC,CAAC;QAClG,MAAM,WAAW,GAAG,MAAM,sBAAY,CAAC,gBAAgB,CAAC,OAAO,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QACzF,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,iCAAiC,CAAC,CAAC,CAAC;YAC5D,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,CAAC;QAC5E,CAAC;aACI,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,sCAAsC,UAAU,EAAE,CAAC,CAAC,CAAC;QACjF,CAAC;IACL,CAAC,CAAC,CAAC;AACX,CAAC"}

package/dist/commands/project/deploy.js

@@ -4,13 +4,61 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerDeploy = registerDeploy;
+const chalk_1 = __importDefault(require("chalk"));
+const fs_1 = require("fs");
+const path_1 = require("path");
+const ConsoleUtils_1 = __importDefault(require("../../utils/ConsoleUtils"));
 const RuntimeUtils_1 = __importDefault(require("../../utils/RuntimeUtils"));
+const shared_1 = require("./shared");
 function registerDeploy(project) {
-    project
-        .command('deploy [service] [zip]')
-        .description('Deploy the project package to the runtime')
-        .action(async (service, zip) => {
-        await RuntimeUtils_1.default.deployProject(service, zip);
+    (0, shared_1.withProjectPathOption)(project
+        .command('deploy')
+        .description('Deploy a packaged project to the runtime')
+        .argument('<service>', 'service name of the project on the runtime (the serviceName of its manifest.json)')
+        .argument('[zip]', "package to deploy, the zip written by 'cn project package' (omitted: pick one under .codenotch/)"))
+        .addHelpText('after', `
+Examples:
+  $ cn project deploy myproject                  pick a zip found under .codenotch/
+  $ cn project package -o ./myproject.zip
+  $ cn project deploy myproject ./myproject.zip
+`)
+        .action(async (service, zip, options) => {
+        const zipPath = zip ?? await pickPackagedZip(options.projectPath);
+        if (zipPath === undefined) {
+            process.exitCode = 1;
+            return;
+        }
+        await RuntimeUtils_1.default.deployProject(service, zipPath);
     });
 }
+/**
+ * Lets the user pick one of the zips of '<project>/.codenotch', where 'cn project package'
+ * writes them, newest first. When stdin is not interactive the newest one is taken.
+ */
+async function pickPackagedZip(projectPath) {
+    const codenotchPath = (0, path_1.join)(projectPath, '.codenotch');
+    const zips = !(0, fs_1.existsSync)(codenotchPath) ? [] : (0, fs_1.readdirSync)(codenotchPath, { withFileTypes: true })
+        .filter(entry => entry.isFile() && entry.name.toLowerCase().endsWith('.zip'))
+        .map(entry => {
+        const filePath = (0, path_1.join)(codenotchPath, entry.name);
+        const stats = (0, fs_1.statSync)(filePath);
+        return { name: entry.name, path: filePath, modified: stats.mtime, size: stats.size };
+    })
+        .sort((a, b) => b.modified.getTime() - a.modified.getTime());
+    if (zips.length === 0) {
+        console.error(chalk_1.default.yellow(`Aborted: no zip found in '${codenotchPath}', run 'cn project package' first (or pass the zip to deploy).`));
+        return undefined;
+    }
+    const choices = zips.map(zip => ({
+        name: zip.name,
+        description: `${zip.modified.toLocaleString()}, ${formatSize(zip.size)}`
+    }));
+    const index = await ConsoleUtils_1.default.select('Package to deploy:', choices);
+    return zips[index].path;
+}
+function formatSize(bytes) {
+    return bytes < 1024 * 1024
+        ? `${Math.max(1, Math.round(bytes / 1024))} KB`
+        : `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
+}
 //# sourceMappingURL=deploy.js.map

package/dist/commands/project/deploy.js.map

@@ -1 +1 @@
-{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../src/commands/project/deploy.ts"],"names":[],"mappings":";;;;;AAGA,wCAOC;AATD,4EAAoD;AAEpD,SAAgB,cAAc,CAAC,OAAgB;IAC3C,OAAO;SACF,OAAO,CAAC,wBAAwB,CAAC;SACjC,WAAW,CAAC,2CAA2C,CAAC;SACxD,MAAM,CAAC,KAAK,EAAE,OAAe,EAAE,GAAW,EAAE,EAAE;QAC3C,MAAM,sBAAY,CAAC,aAAa,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACX,CAAC"}
+{"version":3,"file":"deploy.js","sourceRoot":"","sources":["../../../src/commands/project/deploy.ts"],"names":[],"mappings":";;;;;AAQA,wCAoBC;AA3BD,kDAA0B;AAC1B,2BAAuD;AACvD,+BAA4B;AAC5B,4EAAoD;AACpD,4EAAoD;AACpD,qCAAyE;AAEzE,SAAgB,cAAc,CAAC,OAAgB;IAC3C,IAAA,8BAAqB,EAAC,OAAO;SACxB,OAAO,CAAC,QAAQ,CAAC;SACjB,WAAW,CAAC,0CAA0C,CAAC;SACvD,QAAQ,CAAC,WAAW,EAAE,mFAAmF,CAAC;SAC1G,QAAQ,CAAC,OAAO,EAAE,kGAAkG,CAAC,CAAC;SACtH,WAAW,CAAC,OAAO,EAAE;;;;;CAK7B,CAAC;SACO,MAAM,CAAC,KAAK,EAAE,OAAe,EAAE,GAAuB,EAAE,OAA+B,EAAE,EAAE;QACxF,MAAM,OAAO,GAAG,GAAG,IAAI,MAAM,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QACD,MAAM,sBAAY,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;AACX,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,eAAe,CAAC,WAAmB;IAC9C,MAAM,aAAa,GAAG,IAAA,WAAI,EAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,CAAC,IAAA,eAAU,EAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAA,gBAAW,EAAC,aAAa,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;SAC7F,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;SAC5E,GAAG,CAAC,KAAK,CAAC,EAAE;QACT,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,aAAa,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACjD,MAAM,KAAK,GAAG,IAAA,aAAQ,EAAC,QAAQ,CAAC,CAAC;QACjC,OAAO,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,CAAC;IACzF,CAAC,CAAC;SACD,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IAEjE,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,MAAM,CAAC,6BAA6B,aAAa,gEAAgE,CAAC,CAAC,CAAC;QACxI,OAAO,SAAS,CAAC;IACrB,CAAC;IAED,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,WAAW,EAAE,GAAG,GAAG,CAAC,QAAQ,CAAC,cAAc,EAAE,KAAK,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;KAC3E,CAAC,CAAC,CAAC;IACJ,MAAM,KAAK,GAAG,MAAM,sBAAY,CAAC,MAAM,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACvE,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;AAC5B,CAAC;AAED,SAAS,UAAU,CAAC,KAAa;IAC7B,OAAO,KAAK,GAAG,IAAI,GAAG,IAAI;QACtB,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,KAAK;QAC/C,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC;AACrD,CAAC"}

package/dist/commands/project/inspect.js

@@ -4,14 +4,78 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerInspect = registerInspect;
+const path_1 = require("path");
 const ProjectUtils_1 = __importDefault(require("../../utils/ProjectUtils"));
+const DbSchemaUtils_1 = __importDefault(require("../../utils/DbSchemaUtils"));
 const shared_1 = require("./shared");
 function registerInspect(project) {
     (0, shared_1.withProjectPathOption)(project
         .command('inspect')
-        .description('Parse the project and display its structure and configuration'))
+        .description('Parse the project and display its structure and configuration')
+        .option('--json', 'output the discovered structure as JSON instead of text')
+        .addHelpText('after', `
+Examples:
+  $ cn project inspect           what the sources declare (processes, tables, apps, i18n...)
+  $ cn project inspect --json    the same, machine-readable
+`))
         .action(async (options) => {
+        if (options.json === true) {
+            const info = await ProjectUtils_1.default.collectProjectInfo(options.projectPath);
+            console.log(JSON.stringify(buildJsonReport(options.projectPath, info), null, 4));
+            return;
+        }
         await ProjectUtils_1.default.inspectProject(options.projectPath);
     });
 }
+/**
+ * The machine-readable form of the inspection. A curated shape on purpose: it is a contract for
+ * scripts and coding agents, so it exposes what the text output says (plus the structured
+ * details behind it) rather than freezing the internal discover* interfaces.
+ */
+function buildJsonReport(projectPath, info) {
+    const root = (0, path_1.resolve)(projectPath);
+    // Posix separators whatever the OS, so a consumer does not have to handle both
+    const rel = (filePath) => ((0, path_1.relative)(root, filePath) || filePath).replaceAll('\\', '/');
+    return {
+        path: root,
+        manifest: info.manifest ?? null,
+        package: info.pkgJson ? { name: info.pkgJson.name ?? null, version: info.pkgJson.version ?? null } : null,
+        processes: info.processes.map(process => ({
+            id: process.id ?? null,
+            trigger: process.trigger ?? null,
+            scope: process.scope ?? null,
+            description: process.description ?? null,
+            takesInput: process.takesInput,
+            file: rel(process.filePath),
+            line: process.line
+        })),
+        tables: info.tables.map(table => ({
+            name: table.name ?? null,
+            // The key of 'ctx.tables' in the processes
+            collection: table.name !== undefined ? DbSchemaUtils_1.default.toCollectionName(table.name) : null,
+            columns: table.columns.map(column => ({ name: column.name, type: column.type ?? null, primary: column.isPrimary })),
+            file: rel(table.filePath),
+            line: table.line
+        })),
+        documents: info.documents.map(document => ({
+            name: document.name ?? null,
+            key: document.name?.toLowerCase() ?? null,
+            fields: document.fields.map(field => ({ name: field.name, type: field.type ?? null })),
+            file: rel(document.filePath),
+            line: document.line
+        })),
+        apps: info.apps.map(app => ({
+            name: app.name,
+            type: app.type,
+            title: app.manifest.html?.title ?? app.manifest.app?.name ?? null,
+            script: rel(app.scriptPath),
+            manifest: rel(app.manifestPath)
+        })),
+        i18ns: info.i18ns.map(i18n => ({
+            file: rel(i18n.filePath),
+            languages: i18n.languages,
+            keys: i18n.keys.length
+        }))
+    };
+}
 //# sourceMappingURL=inspect.js.map

package/dist/commands/project/inspect.js.map

@@ -1 +1 @@
-{"version":3,"file":"inspect.js","sourceRoot":"","sources":["../../../src/commands/project/inspect.ts"],"names":[],"mappings":";;;;;AAIA,0CAOC;AAVD,4EAAoD;AACpD,qCAAyE;AAEzE,SAAgB,eAAe,CAAC,OAAgB;IAC5C,IAAA,8BAAqB,EAAC,OAAO;SACxB,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,+DAA+D,CAAC,CAAC;SAC7E,MAAM,CAAC,KAAK,EAAE,OAA+B,EAAE,EAAE;QAC9C,MAAM,sBAAY,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACX,CAAC"}
+{"version":3,"file":"inspect.js","sourceRoot":"","sources":["../../../src/commands/project/inspect.ts"],"names":[],"mappings":";;;;;AAMA,0CAoBC;AAzBD,+BAAyC;AACzC,4EAAoD;AACpD,8EAAsD;AACtD,qCAAyE;AAEzE,SAAgB,eAAe,CAAC,OAAgB;IAC5C,IAAA,8BAAqB,EAAC,OAAO;SACxB,OAAO,CAAC,SAAS,CAAC;SAClB,WAAW,CAAC,+DAA+D,CAAC;SAC5E,MAAM,CAAC,QAAQ,EAAE,yDAAyD,CAAC;SAC3E,WAAW,CAAC,OAAO,EAAE;;;;CAI7B,CAAC,CAAC;SACM,MAAM,CAAC,KAAK,EAAE,OAAoD,EAAE,EAAE;QAEnE,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,MAAM,sBAAY,CAAC,kBAAkB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YACxE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,OAAO,CAAC,WAAW,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACjF,OAAO;QACX,CAAC;QAED,MAAM,sBAAY,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;AACX,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,WAAmB,EAAE,IAAiE;IAE3G,MAAM,IAAI,GAAG,IAAA,cAAO,EAAC,WAAW,CAAC,CAAC;IAClC,+EAA+E;IAC/E,MAAM,GAAG,GAAG,CAAC,QAAgB,EAAE,EAAE,CAAC,CAAC,IAAA,eAAQ,EAAC,IAAI,EAAE,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAE/F,OAAO;QACH,IAAI,EAAE,IAAI;QACV,QAAQ,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI;QAC/B,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI;QACzG,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YACtC,EAAE,EAAE,OAAO,CAAC,EAAE,IAAI,IAAI;YACtB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,IAAI;YAChC,KAAK,EAAE,OAAO,CAAC,KAAK,IAAI,IAAI;YAC5B,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,IAAI;YACxC,UAAU,EAAE,OAAO,CAAC,UAAU;YAC9B,IAAI,EAAE,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC;YAC3B,IAAI,EAAE,OAAO,CAAC,IAAI;SACrB,CAAC,CAAC;QACH,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAC9B,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI;YACxB,2CAA2C;YAC3C,UAAU,EAAE,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,uBAAa,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI;YACxF,OAAO,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACnH,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC;YACzB,IAAI,EAAE,KAAK,CAAC,IAAI;SACnB,CAAC,CAAC;QACH,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACvC,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,IAAI;YAC3B,GAAG,EAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,IAAI;YACzC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC;YACtF,IAAI,EAAE,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC5B,IAAI,EAAE,QAAQ,CAAC,IAAI;SACtB,CAAC,CAAC;QACH,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACxB,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,IAAI,EAAE,GAAG,CAAC,IAAI;YACd,KAAK,EAAE,GAAG,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,IAAI,IAAI;YACjE,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,UAAU,CAAC;YAC3B,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC;SAClC,CAAC,CAAC;QACH,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC3B,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC;YACxB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,MAAM;SACzB,CAAC,CAAC;KACN,CAAC;AACN,CAAC"}

package/dist/commands/project/package.js

@@ -13,10 +13,10 @@ function registerPackage(project) {
         .command('package')
         .alias('build')
         .description('Compile and package the project, output a zip file')
-        .option('-o, --output-path <path>', 'output path for the build zip file')
+        .option('-o, --output-path <path>', 'output path for the build zip file (default .codenotch/build.zip)')
         .option('-i, --ignore-errors', 'ignore compilation errors and proceed with packaging', false))
         .action(async (options) => {
-        const outputPath = options.outputPath ?? path_1.default.join(options.projectPath, "build.zip");
+        const outputPath = options.outputPath ?? path_1.default.join(options.projectPath, ".codenotch", "build.zip");
         const ignoreErrors = options.ignoreErrors ?? false;
         await ProjectUtils_1.default.packageProject(options.projectPath, outputPath, ignoreErrors);
         console.log(chalk_1.default.green(`Project built successfully at ${outputPath}`));

package/dist/commands/project/package.js.map

@@ -1 +1 @@
-{"version":3,"file":"package.js","sourceRoot":"","sources":["../../../src/commands/project/package.ts"],"names":[],"mappings":";;;;;AAMA,0CAaC;AAlBD,kDAA0B;AAC1B,gDAAwB;AACxB,4EAAoD;AACpD,qCAAyE;AAEzE,SAAgB,eAAe,CAAC,OAAgB;IAC5C,IAAA,8BAAqB,EAAC,OAAO;SACxB,OAAO,CAAC,SAAS,CAAC;SAClB,KAAK,CAAC,OAAO,CAAC;SACd,WAAW,CAAC,oDAAoD,CAAC;SACjE,MAAM,CAAC,0BAA0B,EAAE,oCAAoC,CAAC;SACxE,MAAM,CAAC,qBAAqB,EAAE,sDAAsD,EAAE,KAAK,CAAC,CAAC;SAC7F,MAAM,CAAC,KAAK,EAAE,OAAiF,EAAE,EAAE;QAChG,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QACrF,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,KAAK,CAAC;QACnD,MAAM,sBAAY,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,iCAAiC,UAAU,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACX,CAAC"}
+{"version":3,"file":"package.js","sourceRoot":"","sources":["../../../src/commands/project/package.ts"],"names":[],"mappings":";;;;;AAMA,0CAaC;AAlBD,kDAA0B;AAC1B,gDAAwB;AACxB,4EAAoD;AACpD,qCAAyE;AAEzE,SAAgB,eAAe,CAAC,OAAgB;IAC5C,IAAA,8BAAqB,EAAC,OAAO;SACxB,OAAO,CAAC,SAAS,CAAC;SAClB,KAAK,CAAC,OAAO,CAAC;SACd,WAAW,CAAC,oDAAoD,CAAC;SACjE,MAAM,CAAC,0BAA0B,EAAE,mEAAmE,CAAC;SACvG,MAAM,CAAC,qBAAqB,EAAE,sDAAsD,EAAE,KAAK,CAAC,CAAC;SAC7F,MAAM,CAAC,KAAK,EAAE,OAAiF,EAAE,EAAE;QAChG,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,IAAI,cAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;QACnG,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,KAAK,CAAC;QACnD,MAAM,sBAAY,CAAC,cAAc,CAAC,OAAO,CAAC,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QACjF,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,iCAAiC,UAAU,EAAE,CAAC,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;AACX,CAAC"}

package/dist/commands/system/docs.d.ts

@@ -0,0 +1,2 @@
+import { Command } from 'commander';
+export declare function registerDocs(program: Command): void;

package/dist/commands/system/docs.js

@@ -0,0 +1,57 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerDocs = registerDocs;
+const chalk_1 = __importDefault(require("chalk"));
+const DocsUtils_1 = __importDefault(require("../../utils/DocsUtils"));
+function registerDocs(program) {
+    program
+        .command('docs [topic]')
+        .description('Print the reference documentation of a topic, or list the topics')
+        .option('--json', 'output the topic list as JSON instead of text')
+        .addHelpText('after', `
+The documentation ships with the CLI and matches its version. It is written for coding agents
+as much as for developers: the AGENTS.md of a generated project tells them to read the topic
+before writing a file of that kind.
+
+Examples:
+  $ cn docs                lists the topics
+  $ cn docs --json         the same, machine-readable
+  $ cn docs tables         the reference of the table declarations
+`)
+        .action((topic, options) => {
+        const topics = DocsUtils_1.default.listTopics();
+        if (topics.length === 0) {
+            console.error(chalk_1.default.red(`No documentation found at '${DocsUtils_1.default.getDocsFolder()}', the installation looks broken.`));
+            process.exitCode = 1;
+            return;
+        }
+        if (options.json === true) {
+            // The content of a topic is plain markdown already, only the listing has a JSON form
+            if (topic !== undefined) {
+                console.error(chalk_1.default.yellow(`'--json' only applies to the topic list, 'cn docs ${topic}' already prints plain markdown.`));
+                process.exitCode = 1;
+                return;
+            }
+            console.log(JSON.stringify(topics.map(entry => ({ name: entry.name, summary: entry.summary })), null, 4));
+            return;
+        }
+        if (topic === undefined) {
+            for (const entry of topics) {
+                console.log(`${chalk_1.default.cyan(`cn docs ${entry.name}`.padEnd(20))} ${entry.summary}`);
+            }
+            return;
+        }
+        const content = DocsUtils_1.default.readTopic(topic);
+        if (content === undefined) {
+            console.error(chalk_1.default.yellow(`Unknown topic '${topic}', expected one of: ${topics.map(entry => entry.name).join(', ')}.`));
+            process.exitCode = 1;
+            return;
+        }
+        // Raw markdown on purpose: the output is meant to be read by agents and pagers alike
+        console.log(content);
+    });
+}
+//# sourceMappingURL=docs.js.map

package/dist/commands/system/docs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs.js","sourceRoot":"","sources":["../../../src/commands/system/docs.ts"],"names":[],"mappings":";;;;;AAIA,oCAoDC;AAvDD,kDAA0B;AAC1B,sEAA8C;AAE9C,SAAgB,YAAY,CAAC,OAAgB;IACzC,OAAO;SACF,OAAO,CAAC,cAAc,CAAC;SACvB,WAAW,CAAC,kEAAkE,CAAC;SAC/E,MAAM,CAAC,QAAQ,EAAE,+CAA+C,CAAC;SACjE,WAAW,CAAC,OAAO,EAAE;;;;;;;;;CAS7B,CAAC;SACO,MAAM,CAAC,CAAC,KAAyB,EAAE,OAA2B,EAAE,EAAE;QAE/D,MAAM,MAAM,GAAG,mBAAS,CAAC,UAAU,EAAE,CAAC;QACtC,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,8BAA8B,mBAAS,CAAC,aAAa,EAAE,mCAAmC,CAAC,CAAC,CAAC;YACrH,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QAED,IAAI,OAAO,CAAC,IAAI,KAAK,IAAI,EAAE,CAAC;YACxB,qFAAqF;YACrF,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtB,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,MAAM,CAAC,qDAAqD,KAAK,kCAAkC,CAAC,CAAC,CAAC;gBAC1H,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;gBACrB,OAAO;YACX,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC1G,OAAO;QACX,CAAC;QAED,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;gBACzB,OAAO,CAAC,GAAG,CAAC,GAAG,eAAK,CAAC,IAAI,CAAC,WAAW,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YACtF,CAAC;YACD,OAAO;QACX,CAAC;QAED,MAAM,OAAO,GAAG,mBAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,MAAM,CAAC,kBAAkB,KAAK,uBAAuB,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YACzH,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACX,CAAC;QAED,qFAAqF;QACrF,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACzB,CAAC,CAAC,CAAC;AACX,CAAC"}

package/dist/commands/system/index.js

@@ -3,9 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.registerSystemCommands = registerSystemCommands;
 const info_1 = require("./info");
 const read_1 = require("./read");
+const docs_1 = require("./docs");
 // Root-level commands that are not tied to a specific project or the runtime
 function registerSystemCommands(program) {
     (0, info_1.registerInfo)(program);
     (0, read_1.registerRead)(program);
+    (0, docs_1.registerDocs)(program);
 }
 //# sourceMappingURL=index.js.map

package/dist/commands/system/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/system/index.ts"],"names":[],"mappings":";;AAKA,wDAGC;AAPD,iCAAsC;AACtC,iCAAsC;AAEtC,6EAA6E;AAC7E,SAAgB,sBAAsB,CAAC,OAAgB;IACnD,IAAA,mBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,mBAAY,EAAC,OAAO,CAAC,CAAC;AAC1B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/system/index.ts"],"names":[],"mappings":";;AAMA,wDAIC;AATD,iCAAsC;AACtC,iCAAsC;AACtC,iCAAsC;AAEtC,6EAA6E;AAC7E,SAAgB,sBAAsB,CAAC,OAAgB;IACnD,IAAA,mBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,mBAAY,EAAC,OAAO,CAAC,CAAC;IACtB,IAAA,mBAAY,EAAC,OAAO,CAAC,CAAC;AAC1B,CAAC"}

package/dist/commands/system/read.js

@@ -8,8 +8,9 @@ const chalk_1 = __importDefault(require("chalk"));
 const readline_1 = require("readline");
 const process_1 = require("process");
 function registerRead(program) {
+    // Manual test of the readline prompts, of no use to a consumer: kept out of --help
     program
-        .command('read')
+        .command('read', { hidden: true })
         .description('Read test')
         .action(async () => {
         console.log(chalk_1.default.green('Read test:'));

package/dist/commands/system/read.js.map

@@ -1 +1 @@
-{"version":3,"file":"read.js","sourceRoot":"","sources":["../../../src/commands/system/read.ts"],"names":[],"mappings":";;;;;AAKA,oCAmBC;AAvBD,kDAA0B;AAC1B,uCAA2C;AAC3C,qCAA2D;AAE3D,SAAgB,YAAY,CAAC,OAAgB;IACzC,OAAO;SACF,OAAO,CAAC,MAAM,CAAC;SACf,WAAW,CAAC,WAAW,CAAC;SACxB,MAAM,CAAC,KAAK,IAAI,EAAE;QACf,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;QAEvC,MAAM,EAAE,GAAG,IAAA,0BAAe,EAAC,EAAE,KAAK,EAAL,eAAK,EAAE,MAAM,EAAN,gBAAM,EAAE,CAAC,CAAC;QAE9C,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;gBACjD,EAAE,CAAC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,iBAAiB,eAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;gBACO,CAAC;YACL,EAAE,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACL,CAAC,CAAC,CAAC;AACX,CAAC"}
+{"version":3,"file":"read.js","sourceRoot":"","sources":["../../../src/commands/system/read.ts"],"names":[],"mappings":";;;;;AAKA,oCAoBC;AAxBD,kDAA0B;AAC1B,uCAA2C;AAC3C,qCAA2D;AAE3D,SAAgB,YAAY,CAAC,OAAgB;IACzC,mFAAmF;IACnF,OAAO;SACF,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;SACjC,WAAW,CAAC,WAAW,CAAC;SACxB,MAAM,CAAC,KAAK,IAAI,EAAE;QACf,OAAO,CAAC,GAAG,CAAC,eAAK,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC;QAEvC,MAAM,EAAE,GAAG,IAAA,0BAAe,EAAC,EAAE,KAAK,EAAL,eAAK,EAAE,MAAM,EAAN,gBAAM,EAAE,CAAC,CAAC;QAE9C,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,IAAI,OAAO,CAAS,CAAC,OAAO,EAAE,EAAE;gBACjD,EAAE,CAAC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;YACnD,CAAC,CAAC,CAAC;YACH,OAAO,CAAC,GAAG,CAAC,iBAAiB,eAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACzD,CAAC;gBACO,CAAC;YACL,EAAE,CAAC,KAAK,EAAE,CAAC;QACf,CAAC;IACL,CAAC,CAAC,CAAC;AACX,CAAC"}

package/dist/commands/validation/files/ScriptValidator.js

@@ -97,15 +97,16 @@ class CliScriptCompiler {
             options = typescript_1.default.convertCompilerOptionsFromJson(BuildUtils_1.default.defaultCompilerOptions(), basePath).options;
         }
         options.noEmit = true;
-        // Codenotch auto-generated ambient typings (i18n.d.ts, process.d.ts)
-        // NO MORE USAGE OF THIS FOLDER
-        /*const workspacePath = BuildUtils.findWorkspaceFromFile(requestedFiles[0]);
-        if (workspacePath) {
-            const typingsDir = join(workspacePath, 'typings');
-            if (existsSync(typingsDir)) {
-                rootFiles.push(...readdirSync(typingsDir).filter(f => f.endsWith('.d.ts')).map(f => join(typingsDir, f)));
+        // The generated 'db-schema.d.ts' augments '@codenotch/process' with the typed tables and
+        // documents. A tsconfig includes it through its file list (handled above); without one it
+        // has to join the program by hand, or 'ctx.tables.<name>' would not resolve.
+        if (!configPath) {
+            const workspacePath = BuildUtils_1.default.findWorkspaceFromFile(requestedFiles[0]);
+            const dbSchemaPath = workspacePath ? (0, path_1.join)(workspacePath, 'db-schema.d.ts') : undefined;
+            if (dbSchemaPath !== undefined && (0, fs_1.existsSync)(dbSchemaPath)) {
+                rootFiles.push((0, path_1.resolve)(dbSchemaPath));
             }
-        }*/
+        }
         const program = typescript_1.default.createProgram([...new Set(rootFiles)], options);
         const diagnostics = [...configDiagnostics, ...typescript_1.default.getPreEmitDiagnostics(program)];
         const isRequestedFile = (fileName) => requestedFiles.some(f => f.toLowerCase() === (0, path_1.resolve)(fileName).toLowerCase());

package/dist/commands/validation/files/ScriptValidator.js.map

@@ -1 +1 @@
-{"version":3,"file":"ScriptValidator.js","sourceRoot":"","sources":["../../../../src/commands/validation/files/ScriptValidator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA2C;AAC3C,2BAA6C;AAC7C,4DAA4B;AAE5B,2EAAmD;AACnD,yEAAiD;AACjD,yEAAwE;AAExE,MAA8B,eAAe;IAEzC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAA0B;QAC5C,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACzC,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,IAAI,EAAE,OAAO,CAAC,QAAQ;aACzB,CAAC,CAAC,CAAC;IACR,CAAC;IAED,yGAAyG;IACzG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,SAAmB;QACzC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,mBAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAE,EAAE,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACzC,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;CACJ;AAtBD,kCAsBC;AAOD,MAAa,iBAAiB;IAE1B,KAAK,CAAC,QAAQ,CAAC,KAAmB;QAC9B,MAAM,QAAQ,GAA0B,EAAE,CAAC;QAC3C,MAAM,cAAc,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,4EAA4E;QAC5E,wEAAwE;QACxE,MAAM,OAAO,GAAG,oBAAE,CAAC,cAAc,CAAC,SAAS,EAAE,oBAAE,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAChF,IAAI,OAAO,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YAC/E,QAAQ,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE,+BAA+B,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,0FAA0F;aAC1J,CAAC,CAAC;QACP,CAAC;QAED,uFAAuF;QACvF,MAAM,UAAU,GAAG,oBAAE,CAAC,cAAc,CAAC,SAAS,EAAE,oBAAE,CAAC,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QACpF,IAAI,OAA2B,CAAC;QAChC,IAAI,iBAAiB,GAAoB,EAAE,CAAC;QAC5C,IAAI,UAAU,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,oBAAE,CAAC,cAAc,CAAC,UAAU,EAAE,oBAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,oBAAE,CAAC,0BAA0B,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,EAAE,oBAAE,CAAC,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;YACjG,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;YACzB,iBAAiB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1E,4EAA4E;YAC5E,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9F,CAAC;aACI,CAAC;YACF,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC7D,OAAO,GAAG,oBAAE,CAAC,8BAA8B,CAAC,oBAAU,CAAC,sBAAsB,EAAE,EAAE,QAAQ,CAAC,CAAC,OAAO,CAAC;QACvG,CAAC;QACD,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,qEAAqE;QACrE,+BAA+B;QAC/B;;;;;;WAMG;QAEH,MAAM,OAAO,GAAG,oBAAE,CAAC,aAAa,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,CAAC,GAAG,iBAAiB,EAAE,GAAG,oBAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;QAEjF,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,EAAE,CACzC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAElF,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACnC,gEAAgE;YAChE,IAAI,UAAU,CAAC,IAAI,IAAI,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;gBACzE,SAAS;YACb,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,yBAAe,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,SAAS,CAAC,KAAmB;QACzB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACpE,CAAC;IAED,WAAW,CAAC,OAAe;QACvB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACtE,CAAC;CACJ;AAtED,8CAsEC"}
+{"version":3,"file":"ScriptValidator.js","sourceRoot":"","sources":["../../../../src/commands/validation/files/ScriptValidator.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,6CAA2C;AAC3C,2BAAgC;AAChC,4DAA4B;AAE5B,2EAAmD;AACnD,yEAAiD;AACjD,yEAAwE;AAExE,MAA8B,eAAe;IAEzC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,OAA0B;QAC5C,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACzC,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC5B,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,IAAI,EAAE,OAAO,CAAC,QAAQ;aACzB,CAAC,CAAC,CAAC;IACR,CAAC;IAED,yGAAyG;IACzG,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,SAAmB;QACzC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,KAAK,GAAiB,EAAE,CAAC;QAC/B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,MAAM,mBAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAE,EAAE,CAAC,CAAC;QACxF,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,iBAAiB,EAAE,CAAC;QACzC,OAAO,MAAM,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC1C,CAAC;CACJ;AAtBD,kCAsBC;AAOD,MAAa,iBAAiB;IAE1B,KAAK,CAAC,QAAQ,CAAC,KAAmB;QAC9B,MAAM,QAAQ,GAA0B,EAAE,CAAC;QAC3C,MAAM,cAAc,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,CAAC,GAAG,cAAc,CAAC,CAAC;QACtC,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;QAElD,4EAA4E;QAC5E,wEAAwE;QACxE,MAAM,OAAO,GAAG,oBAAE,CAAC,cAAc,CAAC,SAAS,EAAE,oBAAE,CAAC,GAAG,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC;QAChF,IAAI,OAAO,IAAI,IAAA,eAAU,EAAC,IAAA,WAAI,EAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC,CAAC,KAAK,KAAK,EAAE,CAAC;YAC/E,QAAQ,CAAC,IAAI,CAAC;gBACV,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE,+BAA+B,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,0FAA0F;aAC1J,CAAC,CAAC;QACP,CAAC;QAED,uFAAuF;QACvF,MAAM,UAAU,GAAG,oBAAE,CAAC,cAAc,CAAC,SAAS,EAAE,oBAAE,CAAC,GAAG,CAAC,UAAU,EAAE,eAAe,CAAC,CAAC;QACpF,IAAI,OAA2B,CAAC;QAChC,IAAI,iBAAiB,GAAoB,EAAE,CAAC;QAC5C,IAAI,UAAU,EAAE,CAAC;YACb,MAAM,GAAG,GAAG,oBAAE,CAAC,cAAc,CAAC,UAAU,EAAE,oBAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,oBAAE,CAAC,0BAA0B,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,EAAE,oBAAE,CAAC,GAAG,EAAE,cAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC;YACjG,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;YACzB,iBAAiB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1E,4EAA4E;YAC5E,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAA,cAAO,EAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9F,CAAC;aACI,CAAC;YACF,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC7D,OAAO,GAAG,oBAAE,CAAC,8BAA8B,CAAC,oBAAU,CAAC,sBAAsB,EAAE,EAAE,QAAQ,CAAC,CAAC,OAAO,CAAC;QACvG,CAAC;QACD,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;QAEtB,yFAAyF;QACzF,0FAA0F;QAC1F,6EAA6E;QAC7E,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,MAAM,aAAa,GAAG,oBAAU,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1E,MAAM,YAAY,GAAG,aAAa,CAAC,CAAC,CAAC,IAAA,WAAI,EAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACvF,IAAI,YAAY,KAAK,SAAS,IAAI,IAAA,eAAU,EAAC,YAAY,CAAC,EAAE,CAAC;gBACzD,SAAS,CAAC,IAAI,CAAC,IAAA,cAAO,EAAC,YAAY,CAAC,CAAC,CAAC;YAC1C,CAAC;QACL,CAAC;QAED,MAAM,OAAO,GAAG,oBAAE,CAAC,aAAa,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACnE,MAAM,WAAW,GAAG,CAAC,GAAG,iBAAiB,EAAE,GAAG,oBAAE,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;QAEjF,MAAM,eAAe,GAAG,CAAC,QAAgB,EAAE,EAAE,CACzC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;QAElF,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACnC,gEAAgE;YAChE,IAAI,UAAU,CAAC,IAAI,IAAI,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,KAAK,EAAE,CAAC;gBACzE,SAAS;YACb,CAAC;YACD,QAAQ,CAAC,IAAI,CAAC,yBAAe,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,OAAO,QAAQ,CAAC;IACpB,CAAC;IAED,SAAS,CAAC,KAAmB;QACzB,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;IACpE,CAAC;IAED,WAAW,CAAC,OAAe;QACvB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACtE,CAAC;CACJ;AAvED,8CAuEC"}

package/dist/index.js

@@ -48,8 +48,18 @@ const packageJson = JSON.parse((0, fs_1.readFileSync)((0, path_1.join)(__dirname
 const program = new commander_1.Command();
 program
     .name('codenotch-cli')
-    .description('CLI tool for Codenotch platform')
-    .version(packageJson.version);
+    .description('CLI of the Codenotch platform: manage the local runtime, scaffold and deploy projects, generate their derived files, and work on their React apps')
+    .version(packageJson.version)
+    .addHelpText('after', `
+The reference documentation ships with the CLI: 'cn docs' lists its topics (project anatomy,
+tables, processes, queries, apps, i18n). Read the topic before writing a file of that kind.
+
+Getting started:
+  $ cn runtime update       install (or update) the local Codenotch runtime
+  $ cn runtime start
+  $ cn project new          create a project (asks for the template and the name)
+  $ cn project start        build, deploy and open it
+`);
 (0, commands_1.registerAllCommands)(program);
 program.parse();
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,yCAAoC;AACpC,2BAAkC;AAClC,6CAAkC;AAClC,oDAA4B;AAC5B,yCAAiD;AAEjD,2HAA2H;AAC3H,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAEzE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AACzF,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACF,IAAI,CAAC,eAAe,CAAC;KACrB,WAAW,CAAC,iCAAiC,CAAC;KAC9C,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;AAElC,IAAA,8BAAmB,EAAC,OAAO,CAAC,CAAC;AAE7B,OAAO,CAAC,KAAK,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,yCAAoC;AACpC,2BAAkC;AAClC,6CAAkC;AAClC,oDAA4B;AAC5B,yCAAiD;AAEjD,2HAA2H;AAC3H,gBAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAEzE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,iBAAiB,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AACzF,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACF,IAAI,CAAC,eAAe,CAAC;KACrB,WAAW,CAAC,mJAAmJ,CAAC;KAChK,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC;KAC5B,WAAW,CAAC,OAAO,EAAE;;;;;;;;;CASzB,CAAC,CAAC;AAEH,IAAA,8BAAmB,EAAC,OAAO,CAAC,CAAC;AAE7B,OAAO,CAAC,KAAK,EAAE,CAAC"}

package/dist/utils/DbSchemaUtils.d.ts

@@ -1,12 +1,13 @@
-import { IDiscoveredTable } from './ProjectUtils';
+import { IDiscoveredDocument, IDiscoveredTable } from './ProjectUtils';
 export interface IDbSchemaGenerationResult {
     content: string;
     warnings: string[];
 }
 /**
- * Builds the two files describing the database of a project out of its 'defineEntity' declarations:
- * 'db-schema.xml', read by the runtime to migrate the database, and 'db-schema.ts', the typed
- * context the processes use through `ctx.tables`.
+ * Builds the two files describing the database of a project out of its 'defineEntity' and
+ * 'defineDocument' declarations: 'db-schema.xml', read by the runtime to migrate the database,
+ * and 'db-schema.d.ts', which augments the 'ProjectTables' and 'ProjectDocs' interfaces of
+ * '@codenotch/process' so that `ctx.tables.<name>` is typed in the processes.
  */
 export default abstract class DbSchemaUtils {
     /**
@@ -22,15 +23,20 @@ export default abstract class DbSchemaUtils {
     static generateXml(tables: IDiscoveredTable[], version: string): IDbSchemaGenerationResult;
     private static generateColumnXml;
     /**
-     * 'db-schema.ts', the typed database context of the project
+     * 'db-schema.d.ts', the declaration merging file typing `ctx.tables` and the documents:
+     * it augments '@codenotch/process' with one typed handle per table and per document.
+     *
+     * The file must stay a module (have a top level import) for the `declare module` block to be
+     * an augmentation: as a plain script it would *declare* '@codenotch/process' instead of
+     * merging into it. It also only applies to files of the same TypeScript program, hence the
+     * tsconfig of the project has to include it.
      *
      * @param tables tables of the project, see ProjectUtils.discoverTableFiles
-     * @param projectName name of the project, used for the interface name
-     * @param imports import line of each table type, keyed by table name
+     * @param documents documents of the project, see ProjectUtils.discoverDocumentFiles
+     * @param tableImports import line of each table row type, keyed by table name
+     * @param documentImports import line of each document type, keyed by document name
      */
-    static generateTs(tables: IDiscoveredTable[], projectName: string, imports: Map<string, string>): IDbSchemaGenerationResult;
-    /** 'my project' and 'my-project' both give 'MyProjectDbSchema' */
-    private static toInterfaceName;
+    static generateDts(tables: IDiscoveredTable[], documents: IDiscoveredDocument[], tableImports: Map<string, string>, documentImports: Map<string, string>): IDbSchemaGenerationResult;
     /** Splits an import statement back into the type it brings and the file it comes from */
     private static parseImport;
     private static sortByName;