dotmd-cli 0.2.0 → 0.3.0

package/README.md

@@ -7,16 +7,28 @@ Index, query, validate, and lifecycle-manage any collection of `.md` files — p
 ## Install
 
 ```bash
-npm install -g dotmd-cli
+npm install -g dotmd-cli    # global — use `dotmd` anywhere
+npm install -D dotmd-cli    # project devDep — use via npm scripts
 ```
 
 ## Quick Start
 
 ```bash
-dotmd init              # creates dotmd.config.mjs + docs/ + docs/README.md
-dotmd list              # index all docs grouped by status
-dotmd check             # validate frontmatter and references
-dotmd context           # compact briefing (great for LLM context)
+dotmd init                  # creates dotmd.config.mjs, docs/, docs/docs.md
+dotmd new my-feature        # scaffold a new doc with frontmatter
+dotmd list                  # index all docs grouped by status
+dotmd check                 # validate frontmatter and references
+dotmd context               # compact briefing (great for LLM context)
+```
+
+### Shell Completion
+
+```bash
+# bash
+eval "$(dotmd completions bash)"    # add to ~/.bashrc
+
+# zsh
+eval "$(dotmd completions zsh)"     # add to ~/.zshrc
 ```
 
 ## What It Does
@@ -27,8 +39,10 @@ dotmd scans a directory of markdown files, parses their YAML frontmatter, and gi
 - **Query** — filter by status, keyword, module, surface, owner, staleness
 - **Validate** — check for missing fields, broken references, stale dates
 - **Lifecycle** — transition statuses, auto-archive with `git mv`, bump dates
-- **README generation** — auto-generate an index block in your README
+- **Scaffold** — create new docs with frontmatter from the command line
+- **Index generation** — auto-generate a `docs.md` index block
 - **Context briefing** — compact summary designed for AI/LLM consumption
+- **Dry-run** — preview any mutation with `--dry-run` before committing
 
 ## Document Format
 
@@ -58,7 +72,7 @@ The only required field is `status`. Everything else is optional but unlocks mor
 ## Commands
 
 ```
-dotmd list [--verbose]       List docs grouped by status
+dotmd list [--verbose]       List docs grouped by status (default)
 dotmd json                   Full index as JSON
 dotmd check                  Validate frontmatter and references
 dotmd coverage [--json]      Metadata coverage report
@@ -69,7 +83,21 @@ dotmd index [--write]        Generate/update docs.md index block
 dotmd status <file> <status> Transition document status
 dotmd archive <file>         Archive (status + move + index regen)
 dotmd touch <file>           Bump updated date
+dotmd watch [command]        Re-run a command on file changes
+dotmd diff [file]            Show changes since last updated date
+dotmd new <name>             Create a new document with frontmatter
 dotmd init                   Create starter config + docs directory
+dotmd completions <shell>    Output shell completion script (bash, zsh)
+```
+
+### Global Flags
+
+```
+--config <path>        Explicit config file path
+--dry-run, -n          Preview changes without writing anything
+--verbose              Show resolved config details
+--help, -h             Show help (per-command with: dotmd <cmd> --help)
+--version, -v          Show version
 ```
 
 ### Query Filters
@@ -83,6 +111,15 @@ dotmd query --surface backend --checklist-open
 
 Flags: `--status`, `--keyword`, `--module`, `--surface`, `--domain`, `--owner`, `--updated-since`, `--stale`, `--has-next-step`, `--has-blockers`, `--checklist-open`, `--sort`, `--limit`, `--all`, `--git`, `--json`.
 
+### Scaffold a Document
+
+```bash
+dotmd new my-feature                          # creates docs/my-feature.md (status: active)
+dotmd new "API Redesign" --status planned     # custom status
+dotmd new auth-refresh --title "Auth Refresh" # custom title
+dotmd new something --dry-run                 # preview without creating
+```
+
 ### Preset Aliases
 
 Define custom query presets in your config:
@@ -96,6 +133,29 @@ export const presets = {
 
 Then run `dotmd stale` or `dotmd mine` as shorthand.
 
+### Watch Mode
+
+```bash
+dotmd watch              # re-run list on every .md change
+dotmd watch check        # live validation
+dotmd watch context      # live briefing
+```
+
+### Diff & Summarize
+
+Show git changes since each document's `updated` frontmatter date:
+
+```bash
+dotmd diff                           # all drifted docs
+dotmd diff docs/plans/auth.md        # single file
+dotmd diff --stat                    # summary stats only
+dotmd diff --since 2026-01-01        # override date
+dotmd diff --summarize               # AI summary via local MLX model
+dotmd diff --summarize --model mlx-community/Mistral-7B-Instruct-v0.3-4bit
+```
+
+The `--summarize` flag requires `uv` and a local MLX-compatible model. No JS dependencies are added.
+
 ## Configuration
 
 Create `dotmd.config.mjs` at your project root (or run `dotmd init`):
@@ -115,8 +175,8 @@ export const lifecycle = {
   skipWarningsFor: ['archived'],
 };
 
-export const readme = {
-  path: 'docs/plans/README.md',
+export const index = {
+  path: 'docs/docs.md',
   startMarker: '<!-- GENERATED:dotmd:start -->',
   endMarker: '<!-- GENERATED:dotmd:end -->',
 };
@@ -178,9 +238,11 @@ Available: `onArchive`, `onStatusChange`, `onTouch`.
 - **Zero dependencies** — pure Node.js builtins (`fs`, `path`, `child_process`)
 - **No build step** — ships as plain ESM, runs directly
 - **Git-aware** — detects frontmatter date drift vs git history, uses `git mv` for archives
+- **Dry-run everything** — preview any mutation with `--dry-run` / `-n`
 - **Configurable everything** — statuses, taxonomy, lifecycle, validation rules, display
 - **Hook system** — extend with JS functions, no plugin framework to learn
 - **LLM-friendly** — `dotmd context` generates compact briefings for AI assistants
+- **Shell completion** — bash and zsh via `dotmd completions`
 
 ## License
 

package/bin/dotmd.mjs

@@ -12,6 +12,8 @@ import { runStatus, runArchive, runTouch } from '../src/lifecycle.mjs';
 import { runInit } from '../src/init.mjs';
 import { runNew } from '../src/new.mjs';
 import { runCompletions } from '../src/completions.mjs';
+import { runWatch } from '../src/watch.mjs';
+import { runDiff } from '../src/diff.mjs';
 import { die, warn } from '../src/util.mjs';
 
 const __filename = fileURLToPath(import.meta.url);
@@ -33,6 +35,8 @@ Commands:
   status <file> <status> Transition document status
   archive <file>         Archive (status + move + index regen)
   touch <file>           Bump updated date
+  watch [command]       Re-run a command on file changes
+  diff [file]           Show changes since last updated date
   new <name>             Create a new document with frontmatter
   init                   Create starter config + docs directory
   completions <shell>    Output shell completion script (bash, zsh)
@@ -97,6 +101,27 @@ Options:
 The filename is derived from <name> by slugifying it.
 Use --dry-run (-n) to preview without creating the file.`,
 
+  watch: `dotmd watch [command] — re-run a command on file changes
+
+Watches the docs root for .md file changes and re-runs the specified
+command. Defaults to 'list' if no command given.
+
+Examples:
+  dotmd watch              # re-run list on changes
+  dotmd watch check        # re-run check on changes
+  dotmd watch context      # live briefing`,
+
+  diff: `dotmd diff [file] — show changes since last updated date
+
+Shows git diffs for docs that changed after their frontmatter updated date.
+Without a file argument, shows all drifted docs.
+
+Options:
+  --stat                 Summary only (files changed, insertions/deletions)
+  --since <date>         Override: diff since this date instead of frontmatter
+  --summarize            Generate AI summary using local MLX model
+  --model <name>         MLX model to use (default: mlx-community/Llama-3.2-3B-Instruct-4bit)`,
+
   init: `dotmd init — create starter config and docs directory
 
 Creates dotmd.config.mjs, docs/, and docs/docs.md in the current
@@ -167,6 +192,10 @@ async function main() {
     return;
   }
 
+  // Watch and diff (handle their own index building)
+  if (command === 'watch') { runWatch(restArgs, config); return; }
+  if (command === 'diff') { runDiff(restArgs, config); return; }
+
   // Lifecycle commands
   if (command === 'status') { runStatus(restArgs, config, { dryRun }); return; }
   if (command === 'archive') { runArchive(restArgs, config, { dryRun }); return; }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dotmd-cli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Zero-dependency CLI for managing markdown documents with YAML frontmatter — index, query, validate, lifecycle.",
   "type": "module",
   "license": "MIT",

package/src/completions.mjs

@@ -2,7 +2,7 @@ import { die } from './util.mjs';
 
 const COMMANDS = [
   'list', 'json', 'check', 'coverage', 'context', 'focus', 'query',
-  'index', 'status', 'archive', 'touch', 'init', 'new', 'completions',
+  'index', 'status', 'archive', 'touch', 'watch', 'diff', 'init', 'new', 'completions',
 ];
 
 const GLOBAL_FLAGS = ['--config', '--dry-run', '--verbose', '--help', '--version'];
@@ -15,6 +15,7 @@ const COMMAND_FLAGS = {
   list: ['--verbose'],
   coverage: ['--json'],
   new: ['--status', '--title'],
+  diff: ['--stat', '--since', '--summarize', '--model'],
 };
 
 function bashCompletion() {

package/src/diff.mjs

@@ -0,0 +1,114 @@
+import { readFileSync } from 'node:fs';
+import { spawnSync } from 'node:child_process';
+import { extractFrontmatter, parseSimpleFrontmatter } from './frontmatter.mjs';
+import { asString, toRepoPath, resolveDocPath, die, warn } from './util.mjs';
+import { gitDiffSince } from './git.mjs';
+import { buildIndex } from './index.mjs';
+import { bold, dim, green } from './color.mjs';
+
+export function runDiff(argv, config) {
+  // Parse flags
+  let file = null;
+  let stat = false;
+  let sinceOverride = null;
+  let summarize = false;
+  let model = 'mlx-community/Llama-3.2-3B-Instruct-4bit';
+
+  for (let i = 0; i < argv.length; i++) {
+    if (argv[i] === '--stat') { stat = true; continue; }
+    if (argv[i] === '--summarize') { summarize = true; continue; }
+    if (argv[i] === '--since' && argv[i + 1]) { sinceOverride = argv[++i]; continue; }
+    if (argv[i] === '--model' && argv[i + 1]) { model = argv[++i]; continue; }
+    if (!argv[i].startsWith('-')) { file = argv[i]; }
+  }
+
+  if (file) {
+    // Single file mode
+    const filePath = resolveDocPath(file, config);
+    if (!filePath) {
+      die(`File not found: ${file}\nSearched: ${toRepoPath(config.repoRoot, config.repoRoot) || '.'}, ${toRepoPath(config.docsRoot, config.repoRoot)}`);
+      return;
+    }
+
+    const raw = readFileSync(filePath, 'utf8');
+    const { frontmatter } = extractFrontmatter(raw);
+    const parsed = parseSimpleFrontmatter(frontmatter);
+    const since = sinceOverride ?? asString(parsed.updated);
+
+    if (!since) {
+      die(`No updated date found in ${file} and no --since provided.`);
+      return;
+    }
+
+    const relPath = toRepoPath(filePath, config.repoRoot);
+    const diffOutput = gitDiffSince(relPath, since, config.repoRoot, { stat });
+
+    if (!diffOutput) {
+      process.stdout.write(`No changes since ${since} for ${relPath}\n`);
+      return;
+    }
+
+    printFileDiff(relPath, since, diffOutput, { summarize, model, config });
+  } else {
+    // All drifted docs mode
+    const index = buildIndex(config);
+    const drifted = [];
+
+    for (const doc of index.docs) {
+      if (!doc.updated) continue;
+      const relPath = doc.path;
+      const since = sinceOverride ?? doc.updated;
+      const diffOutput = gitDiffSince(relPath, since, config.repoRoot, { stat });
+      if (diffOutput && diffOutput.trim()) {
+        drifted.push({ relPath, since, diffOutput });
+      }
+    }
+
+    if (drifted.length === 0) {
+      process.stdout.write('No drifted docs.\n');
+      return;
+    }
+
+    process.stdout.write(bold(`${drifted.length} doc(s) with changes since their updated date:\n\n`));
+    for (const { relPath, since, diffOutput } of drifted) {
+      printFileDiff(relPath, since, diffOutput, { summarize, model, config });
+    }
+  }
+}
+
+function printFileDiff(relPath, since, diffOutput, opts) {
+  process.stdout.write(bold(relPath) + dim(` (updated: ${since})`) + '\n');
+
+  if (opts.summarize) {
+    const summary = summarizeWithMLX(diffOutput, relPath, opts.model);
+    if (summary) {
+      process.stdout.write(dim(`  Summary: ${summary}`) + '\n');
+    } else {
+      warn('  Summary unavailable (model call failed)');
+    }
+  }
+
+  process.stdout.write(diffOutput);
+  process.stdout.write('\n');
+}
+
+function summarizeWithMLX(diffText, filePath, model) {
+  const prompt = `Summarize this git diff in 1-2 sentences. Focus on what changed semantically, not line counts.\n\nFile: ${filePath}\n\n${diffText.slice(0, 4000)}`;
+
+  const result = spawnSync('uv', [
+    'run', '--with', 'mlx-lm',
+    'python3', '-m', 'mlx_lm', 'generate',
+    '--model', model,
+    '--prompt', prompt,
+    '--max-tokens', '150',
+    '--verbose', 'false',
+  ], { encoding: 'utf8', timeout: 120000 });
+
+  if (result.status !== 0) {
+    return null;
+  }
+
+  const output = result.stdout.trim();
+  const lines = output.split('\n').filter(l => !l.includes('Fetching') && !l.includes('Warning:') && !l.includes('=========='));
+  return lines.join(' ').trim() || null;
+}

package/src/git.mjs

@@ -16,3 +16,20 @@ export function gitMv(source, target, repoRoot) {
   });
   return { status: result.status, stderr: result.stderr };
 }
+
+export function gitDiffSince(relPath, sinceDate, repoRoot, opts = {}) {
+  // Find the last commit at or before sinceDate
+  const baseline = spawnSync('git', [
+    'log', '-1', '--before=' + sinceDate + 'T23:59:59', '--format=%H', '--', relPath
+  ], { cwd: repoRoot, encoding: 'utf8' });
+
+  const baseRef = baseline.stdout.trim();
+  if (!baseRef) return null;
+
+  const diffArgs = ['diff', baseRef, 'HEAD'];
+  if (opts.stat) diffArgs.push('--stat');
+  diffArgs.push('--', relPath);
+
+  const result = spawnSync('git', diffArgs, { cwd: repoRoot, encoding: 'utf8' });
+  return result.stdout || null;
+}

package/src/lifecycle.mjs

@@ -1,7 +1,7 @@
 import { existsSync, readFileSync, writeFileSync } from 'node:fs';
 import path from 'node:path';
 import { extractFrontmatter, parseSimpleFrontmatter } from './frontmatter.mjs';
-import { asString, toRepoPath, die } from './util.mjs';
+import { asString, toRepoPath, die, resolveDocPath } from './util.mjs';
 import { gitMv } from './git.mjs';
 import { buildIndex, collectDocFiles } from './index.mjs';
 import { renderIndexFile, writeIndex } from './index-file.mjs';
@@ -188,19 +188,6 @@ export function runTouch(argv, config, opts = {}) {
   config.hooks.onTouch?.({ path: toRepoPath(filePath, config.repoRoot) }, { path: toRepoPath(filePath, config.repoRoot), date: today });
 }
 
-function resolveDocPath(input, config) {
-  if (!input) return null;
-  if (path.isAbsolute(input)) return existsSync(input) ? input : null;
-
-  let candidate = path.resolve(config.repoRoot, input);
-  if (existsSync(candidate)) return candidate;
-
-  candidate = path.resolve(config.docsRoot, input);
-  if (existsSync(candidate)) return candidate;
-
-  return null;
-}
-
 export function updateFrontmatter(filePath, updates) {
   const raw = readFileSync(filePath, 'utf8');
   if (!raw.startsWith('---\n')) throw new Error(`${filePath} has no frontmatter block.`);

package/src/util.mjs

@@ -1,3 +1,4 @@
+import { existsSync } from 'node:fs';
 import path from 'node:path';
 import { dim } from './color.mjs';
 
@@ -58,3 +59,16 @@ export function die(message) {
   process.stderr.write(`${message}\n`);
   process.exitCode = 1;
 }
+
+export function resolveDocPath(input, config) {
+  if (!input) return null;
+  if (path.isAbsolute(input)) return existsSync(input) ? input : null;
+
+  let candidate = path.resolve(config.repoRoot, input);
+  if (existsSync(candidate)) return candidate;
+
+  candidate = path.resolve(config.docsRoot, input);
+  if (existsSync(candidate)) return candidate;
+
+  return null;
+}

package/src/watch.mjs

@@ -0,0 +1,48 @@
+import { watch } from 'node:fs';
+import { spawnSync } from 'node:child_process';
+import path from 'node:path';
+import { dim } from './color.mjs';
+
+export function runWatch(argv, config) {
+  const subCommand = argv.length > 0 ? argv : ['list'];
+  const cliPath = path.join(path.dirname(new URL(import.meta.url).pathname), '..', 'bin', 'dotmd.mjs');
+
+  let lastRun = 0;
+  const DEBOUNCE = 300;
+
+  function run() {
+    const now = Date.now();
+    if (now - lastRun < DEBOUNCE) return;
+    lastRun = now;
+
+    // Clear terminal
+    process.stdout.write('\x1b[2J\x1b[H');
+    process.stderr.write(dim(`[${new Date().toLocaleTimeString()}] dotmd ${subCommand.join(' ')}`) + '\n\n');
+
+    spawnSync(process.execPath, [cliPath, ...subCommand], {
+      stdio: 'inherit',
+      cwd: process.cwd(),
+    });
+  }
+
+  // Run once immediately
+  run();
+
+  process.stderr.write(dim(`\nWatching ${config.docsRoot} for changes... (Ctrl+C to stop)`) + '\n');
+
+  // Watch for changes
+  const watcher = watch(config.docsRoot, { recursive: true }, (eventType, filename) => {
+    if (filename && filename.endsWith('.md')) {
+      run();
+    }
+  });
+
+  // Clean exit
+  process.on('SIGINT', () => {
+    watcher.close();
+    process.exit(0);
+  });
+
+  // Keep alive
+  setInterval(() => {}, 1 << 30);
+}