sysprom 1.13.0 → 1.13.2

package/README.md

@@ -23,8 +23,8 @@ Both `sysprom` and `spm` are available as commands.
 
 ```sh
 # Convert between formats
-spm json2md .spm.json ./.spm
-spm md2json ./.spm output.spm.json
+spm json2md --input .spm.json --output ./.spm
+spm md2json --input ./.spm --output output.spm.json
 
 # Validate and summarise (auto-detects .spm.json in current directory)
 spm validate
@@ -223,17 +223,17 @@ All significant activity — decisions, changes, new capabilities, and invariant
 spm add decision --id D23 --name "My Decision" --context "Why this was needed"
 
 # Or edit ./.spm/DECISIONS.md directly, then sync
-spm md2json ./.spm .spm.json
+spm md2json --input ./.spm --output .spm.json
 ```
 
 Keep both representations in sync after any change:
 
 ```sh
 # JSON → Markdown
-spm json2md .spm.json ./.spm
+spm json2md --input .spm.json --output ./.spm
 
 # Markdown → JSON
-spm md2json ./.spm .spm.json
+spm md2json --input ./.spm --output .spm.json
 ```
 
 > **Important:** Always keep `.spm.json` and `./.spm/` up to date with current activity and in sync with each other. Record all decisions, changes, and new capabilities as they happen. After any change to either representation, run the appropriate conversion command above. Validate with `spm validate` before committing.

package/dist/src/cli/commands/init.d.ts

@@ -1,9 +1,7 @@
 import * as z from "zod";
 import type { CommandDef } from "../define-command.js";
-declare const argsSchema: z.ZodObject<{
-    path: z.ZodDefault<z.ZodOptional<z.ZodString>>;
-}, z.core.$strip>;
 declare const optsSchema: z.ZodObject<{
+    path: z.ZodDefault<z.ZodOptional<z.ZodString>>;
     title: z.ZodOptional<z.ZodString>;
     scope: z.ZodOptional<z.ZodString>;
     format: z.ZodOptional<z.ZodEnum<{
@@ -12,5 +10,5 @@ declare const optsSchema: z.ZodObject<{
         dir: "dir";
     }>>;
 }, z.core.$strict>;
-export declare const initCommand: CommandDef<typeof argsSchema, typeof optsSchema>;
+export declare const initCommand: CommandDef<z.ZodObject<z.ZodRawShape>, typeof optsSchema>;
 export {};

package/dist/src/cli/commands/init.js

@@ -35,15 +35,13 @@ function resolveInitTarget(pathArg, format) {
         ioFormat: formatToIoFormat(fmt),
     };
 }
-const argsSchema = z.object({
+const optsSchema = z
+    .object({
     path: z
         .string()
         .optional()
         .default(".")
         .describe("Target path (default: current directory)"),
-});
-const optsSchema = z
-    .object({
     title: z.string().optional().describe("Document title"),
     scope: z.string().optional().describe("Document scope"),
     format: z
@@ -56,10 +54,9 @@ export const initCommand = {
     name: "init",
     description: initDocumentOp.def.description,
     apiLink: initDocumentOp.def.name,
-    args: argsSchema,
     opts: optsSchema,
-    action(args, opts) {
-        const { outputPath, ioFormat } = resolveInitTarget(args.path, opts.format);
+    action(_args, opts) {
+        const { outputPath, ioFormat } = resolveInitTarget(opts.path, opts.format);
         if (existsSync(outputPath)) {
             console.error(`Already exists: ${outputPath}`);
             process.exit(1);

package/dist/src/cli/commands/json2md.d.ts

@@ -1,2 +1,9 @@
+import * as z from "zod";
 import type { CommandDef } from "../define-command.js";
-export declare const json2mdCommand: CommandDef;
+declare const optsSchema: z.ZodObject<{
+    input: z.ZodString;
+    output: z.ZodString;
+    singleFile: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export declare const json2mdCommand: CommandDef<z.ZodObject<z.ZodRawShape>, typeof optsSchema>;
+export {};

package/dist/src/cli/commands/json2md.js

@@ -4,35 +4,24 @@ import { resolve } from "node:path";
 import { SysProMDocument } from "../../schema.js";
 import { jsonToMarkdown } from "../../json-to-md.js";
 import { jsonToMarkdownOp } from "../../operations/index.js";
-function isArgs(arg) {
-    return (typeof arg === "object" && arg !== null && "input" in arg && "output" in arg);
-}
-function isOpts(opt) {
-    return typeof opt === "object" && opt !== null;
-}
+const optsSchema = z
+    .object({
+    input: z.string().describe("Path to SysProM JSON file"),
+    output: z.string().describe("Output path (file or directory)"),
+    singleFile: z
+        .boolean()
+        .optional()
+        .describe("Force single-file output format"),
+})
+    .strict();
 export const json2mdCommand = {
     name: "json2md",
     description: jsonToMarkdownOp.def.description,
     apiLink: jsonToMarkdownOp.def.name,
-    args: z.object({
-        input: z.string().describe("Path to SysProM JSON file"),
-        output: z.string().describe("Output path (file or directory)"),
-    }),
-    opts: z
-        .object({
-        singleFile: z
-            .boolean()
-            .optional()
-            .describe("Force single-file output format"),
-    })
-        .strict(),
-    action(args, opts) {
-        if (!isArgs(args))
-            throw new Error("Invalid args");
-        if (!isOpts(opts))
-            throw new Error("Invalid opts");
-        const inputPath = resolve(args.input);
-        const outputPath = resolve(args.output);
+    opts: optsSchema,
+    action(_args, opts) {
+        const inputPath = resolve(opts.input);
+        const outputPath = resolve(opts.output);
         const raw = JSON.parse(readFileSync(inputPath, "utf8"));
         if (!SysProMDocument.is(raw)) {
             const result = SysProMDocument.safeParse(raw);

package/dist/src/cli/commands/md2json.d.ts

@@ -1,2 +1,8 @@
+import * as z from "zod";
 import type { CommandDef } from "../define-command.js";
-export declare const md2jsonCommand: CommandDef;
+declare const optsSchema: z.ZodObject<{
+    input: z.ZodString;
+    output: z.ZodString;
+}, z.core.$strict>;
+export declare const md2jsonCommand: CommandDef<z.ZodObject<z.ZodRawShape>, typeof optsSchema>;
+export {};

package/dist/src/cli/commands/md2json.js

@@ -4,23 +4,20 @@ import { resolve } from "node:path";
 import { markdownToJson } from "../../md-to-json.js";
 import { canonicalise } from "../../canonical-json.js";
 import { markdownToJsonOp } from "../../operations/index.js";
-function isArgs(arg) {
-    return (typeof arg === "object" && arg !== null && "input" in arg && "output" in arg);
-}
+const optsSchema = z
+    .object({
+    input: z.string().describe("Path to SysProM Markdown (file or directory)"),
+    output: z.string().describe("Output JSON file path"),
+})
+    .strict();
 export const md2jsonCommand = {
     name: "md2json",
     description: markdownToJsonOp.def.description,
     apiLink: markdownToJsonOp.def.name,
-    args: z.object({
-        input: z.string().describe("Path to SysProM Markdown (file or directory)"),
-        output: z.string().describe("Output JSON file path"),
-    }),
-    opts: z.object({}).strict(),
-    action(args) {
-        if (!isArgs(args))
-            throw new Error("Invalid args");
-        const inputPath = resolve(args.input);
-        const outputPath = resolve(args.output);
+    opts: optsSchema,
+    action(_args, opts) {
+        const inputPath = resolve(opts.input);
+        const outputPath = resolve(opts.output);
         const doc = markdownToJson(inputPath);
         writeFileSync(outputPath, canonicalise(doc, { indent: "\t" }) + "\n");
         console.log(`Written to ${outputPath}`);

package/dist/src/cli/commands/plan.js

@@ -6,10 +6,8 @@ import { planInitOp, planAddTaskOp, planStatusOp, planProgressOp, planGateOp, }
 // ============================================================================
 // Subcommands
 // ============================================================================
-const initArgs = z.object({
-    output: z.string().describe("Path to output SysProM file"),
-});
 const initOpts = z.object({
+    output: z.string().describe("Path to output SysProM file"),
     prefix: z.string().describe("Plan prefix (e.g. PLAN)"),
     name: z.string().optional().describe("Plan name (defaults to prefix)"),
 });
@@ -17,10 +15,9 @@ const initSubcommand = {
     name: "init",
     description: planInitOp.def.description,
     apiLink: planInitOp.def.name,
-    args: initArgs,
     opts: initOpts,
-    action(args, opts) {
-        const outputPath = args.output;
+    action(_args, opts) {
+        const outputPath = opts.output;
         const prefix = opts.prefix;
         const name = opts.name ?? prefix;
         if (existsSync(outputPath)) {

package/dist/src/cli/commands/speckit.js

@@ -45,11 +45,9 @@ function compareDocuments(oldDoc, newDoc) {
 // ============================================================================
 // Subcommands
 // ============================================================================
-const importArgs = z.object({
+const importOpts = z.object({
     speckitDir: z.string().describe("Path to Spec-Kit feature directory"),
     output: z.string().describe("Path to output SysProM file"),
-});
-const importOpts = z.object({
     prefix: z
         .string()
         .optional()
@@ -58,11 +56,10 @@ const importOpts = z.object({
 const importSubcommand = {
     name: "import",
     description: speckitImportOp.def.description,
-    args: importArgs,
     opts: importOpts,
-    action(args, opts) {
-        const specKitDir = resolve(args.speckitDir);
-        const outputPath = resolve(args.output);
+    action(_args, opts) {
+        const specKitDir = resolve(opts.speckitDir);
+        const outputPath = resolve(opts.output);
         if (!existsSync(specKitDir)) {
             console.error(`Error: Spec-Kit directory does not exist: ${specKitDir}`);
             process.exit(1);
@@ -97,21 +94,18 @@ const importSubcommand = {
         console.log(`  ${String(nodeCount)} nodes, ${String(relationshipCount)} relationships`);
     },
 };
-const exportArgs = z.object({
+const exportOpts = z.object({
     input: z.string().describe("Path to SysProM document"),
     speckitDir: z.string().describe("Path to Spec-Kit output directory"),
-});
-const exportOpts = z.object({
     prefix: z.string().describe("ID prefix identifying nodes to export"),
 });
 const exportSubcommand = {
     name: "export",
     description: speckitExportOp.def.description,
-    args: exportArgs,
     opts: exportOpts,
-    action(args, opts) {
-        const inputPath = resolve(args.input);
-        const specKitDir = resolve(args.speckitDir);
+    action(_args, opts) {
+        const inputPath = resolve(opts.input);
+        const specKitDir = resolve(opts.speckitDir);
         if (!opts.prefix) {
             console.error("Error: --prefix flag is required for export (identifies which nodes to export)");
             process.exit(1);
@@ -125,11 +119,9 @@ const exportSubcommand = {
         console.log(`  Generated Spec-Kit files with prefix: ${opts.prefix}`);
     },
 };
-const syncArgs = z.object({
+const syncSubOpts = z.object({
     input: z.string().describe("Path to SysProM document"),
     speckitDir: z.string().describe("Path to Spec-Kit directory"),
-});
-const syncOpts = z.object({
     prefix: z
         .string()
         .optional()
@@ -138,11 +130,10 @@ const syncOpts = z.object({
 const syncSubcommand = {
     name: "sync",
     description: speckitSyncOp.def.description,
-    args: syncArgs,
-    opts: syncOpts,
-    action(args, opts) {
-        const inputPath = resolve(args.input);
-        const specKitDir = resolve(args.speckitDir);
+    opts: syncSubOpts,
+    action(_args, opts) {
+        const inputPath = resolve(opts.input);
+        const specKitDir = resolve(opts.speckitDir);
         if (!existsSync(inputPath)) {
             console.error(`Error: Input file does not exist: ${inputPath}`);
             process.exit(1);
@@ -226,11 +217,9 @@ const syncSubcommand = {
         }
     },
 };
-const diffArgs = z.object({
+const diffSubOpts = z.object({
     input: z.string().describe("Path to SysProM document"),
     speckitDir: z.string().describe("Path to Spec-Kit directory"),
-});
-const diffOpts = z.object({
     prefix: z
         .string()
         .optional()
@@ -239,11 +228,10 @@ const diffOpts = z.object({
 const diffSubcommand = {
     name: "diff",
     description: speckitDiffOp.def.description,
-    args: diffArgs,
-    opts: diffOpts,
-    action(args, opts) {
-        const inputPath = resolve(args.input);
-        const specKitDir = resolve(args.speckitDir);
+    opts: diffSubOpts,
+    action(_args, opts) {
+        const inputPath = resolve(opts.input);
+        const specKitDir = resolve(opts.speckitDir);
         if (!existsSync(inputPath)) {
             console.error(`Error: Input file does not exist: ${inputPath}`);
             process.exit(1);

package/dist/src/cli/commands/sync.d.ts

@@ -1,3 +1,4 @@
+import * as z from "zod";
 import type { CommandDef } from "../define-command.js";
 import { type BidirectionalSyncResult, type ConflictStrategy } from "../../operations/index.js";
 interface SyncCommandInput {
@@ -14,5 +15,13 @@ interface SyncCommandInput {
  * const result = syncCommand({ jsonPath: "doc.spm.json", mdPath: "doc.spm.md" });
  */
 export declare function syncCommand(input: SyncCommandInput): BidirectionalSyncResult;
-export declare const syncCommandDef: CommandDef;
+declare const syncOpts: z.ZodObject<{
+    input: z.ZodString;
+    output: z.ZodString;
+    preferJson: z.ZodOptional<z.ZodBoolean>;
+    preferMd: z.ZodOptional<z.ZodBoolean>;
+    dryRun: z.ZodOptional<z.ZodBoolean>;
+    report: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export declare const syncCommandDef: CommandDef<z.ZodObject<z.ZodRawShape>, typeof syncOpts>;
 export {};

package/dist/src/cli/commands/sync.js

@@ -47,47 +47,36 @@ export function syncCommand(input) {
     }
     return result;
 }
-function isArgs(arg) {
-    return (typeof arg === "object" && arg !== null && "input" in arg && "output" in arg);
-}
-function isOpts(opt) {
-    return typeof opt === "object" && opt !== null;
-}
+const syncOpts = z
+    .object({
+    input: z.string().describe("Path to JSON file"),
+    output: z.string().describe("Path to Markdown file"),
+    preferJson: z
+        .boolean()
+        .optional()
+        .describe("Prefer JSON as source of truth in conflicts"),
+    preferMd: z
+        .boolean()
+        .optional()
+        .describe("Prefer Markdown as source of truth in conflicts"),
+    dryRun: z
+        .boolean()
+        .optional()
+        .describe("Preview changes without writing files"),
+    report: z
+        .boolean()
+        .optional()
+        .describe("Report conflicts without resolving"),
+})
+    .strict();
 export const syncCommandDef = {
     name: "sync",
     description: "Synchronise JSON and Markdown representations with conflict resolution",
     apiLink: "syncDocuments",
-    args: z.object({
-        input: z.string().describe("Path to JSON file"),
-        output: z.string().describe("Path to Markdown file"),
-    }),
-    opts: z
-        .object({
-        preferJson: z
-            .boolean()
-            .optional()
-            .describe("Prefer JSON as source of truth in conflicts"),
-        preferMd: z
-            .boolean()
-            .optional()
-            .describe("Prefer Markdown as source of truth in conflicts"),
-        dryRun: z
-            .boolean()
-            .optional()
-            .describe("Preview changes without writing files"),
-        report: z
-            .boolean()
-            .optional()
-            .describe("Report conflicts without resolving"),
-    })
-        .strict(),
-    action(args, opts) {
-        if (!isArgs(args))
-            throw new Error("Invalid args");
-        if (!isOpts(opts))
-            throw new Error("Invalid opts");
-        const jsonPath = resolve(args.input);
-        const mdPath = resolve(args.output);
+    opts: syncOpts,
+    action(_args, opts) {
+        const jsonPath = resolve(opts.input);
+        const mdPath = resolve(opts.output);
         // Determine conflict strategy
         let strategy = "json";
         if (opts.preferMd)

package/dist/src/cli/program.js

@@ -1,6 +1,31 @@
+import { existsSync, readFileSync } from "node:fs";
+import { dirname, resolve } from "node:path";
+import { fileURLToPath } from "node:url";
 import { Command } from "commander";
-import packageJson from "../../package.json" with { type: "json" };
 import { buildCommander } from "./define-command.js";
+let cachedVersion;
+function getVersion() {
+    if (cachedVersion === undefined) {
+        const __dirname = dirname(fileURLToPath(import.meta.url));
+        // Works from both src/cli/ (../../) and dist/src/cli/ (../../../)
+        const candidates = [
+            resolve(__dirname, "../../package.json"),
+            resolve(__dirname, "../../../package.json"),
+        ];
+        const pkgPath = candidates.find((p) => existsSync(p) && !p.includes("/dist/"));
+        if (!pkgPath)
+            throw new Error("Could not find sysprom package.json");
+        const pkg = JSON.parse(readFileSync(pkgPath, "utf8"));
+        if (typeof pkg !== "object" ||
+            pkg === null ||
+            !("version" in pkg) ||
+            typeof pkg.version !== "string") {
+            throw new Error("Invalid package.json: missing version field");
+        }
+        cachedVersion = pkg.version;
+    }
+    return cachedVersion;
+}
 import { validateCommand } from "./commands/validate.js";
 import { statsCommand } from "./commands/stats.js";
 import { json2mdCommand } from "./commands/json2md.js";
@@ -22,7 +47,11 @@ export const program = new Command();
 program
     .name("sysprom")
     .description("System Provenance Model CLI — record where every part of a system came from")
-    .version(packageJson.version)
+    .option("-V, --version", "output the version number")
+    .on("option:version", () => {
+    console.log(getVersion());
+    process.exit(0);
+})
     .showHelpAfterError(true);
 export const commands = [
     validateCommand,

package/dist/src/cli/shared.d.ts

@@ -1,8 +1,6 @@
 import * as z from "zod";
 import { type Format } from "../io.js";
 import type { SysProMDocument } from "../schema.js";
-/** @deprecated Use --path option in readOpts/mutationOpts instead. */
-export declare const inputArg: z.ZodString;
 /** Empty args schema for commands that take no positional arguments. */
 export declare const noArgs: z.ZodObject<{}, z.core.$strict>;
 /**

package/dist/src/cli/shared.js

@@ -6,10 +6,6 @@ import { jsonToMarkdownMultiDoc } from "../json-to-md.js";
 // ---------------------------------------------------------------------------
 // Reusable CLI schemas — shared across all commands
 // ---------------------------------------------------------------------------
-/** @deprecated Use --path option in readOpts/mutationOpts instead. */
-export const inputArg = z
-    .string()
-    .describe("SysProM document path (JSON, .md, or directory)");
 /** Empty args schema for commands that take no positional arguments. */
 export const noArgs = z.object({}).strict();
 /** Shared --path option for specifying the SysProM document location. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sysprom",
-  "version": "1.13.0",
+  "version": "1.13.2",
   "description": "SysProM — System Provenance Model CLI and library",
   "author": "ExaDev",
   "homepage": "https://exadev.github.io/SysProM",