@way_marks/cli 4.0.0 → 4.0.2

package/dist/index.js

@@ -1,6 +1,57 @@
 #!/usr/bin/env node
 "use strict";
+function getVersion() {
+    // dist/index.js → ../package.json (when published or installed globally)
+    // dev (ts-node from src/) → ../package.json relative to repo
+    try {
+        return require('../package.json').version || 'unknown';
+    }
+    catch { }
+    try {
+        return require('../../package.json').version || 'unknown';
+    }
+    catch { }
+    return 'unknown';
+}
+function printVersion() {
+    console.log(`@way_marks/cli ${getVersion()}`);
+}
+function printHelp() {
+    console.log(`waymark ${getVersion()} — control what AI agents can do in your codebase`);
+    console.log('');
+    console.log('Usage: waymark <command> [options]   (also: way_marks, npx @way_marks/cli)');
+    console.log('');
+    console.log('Commands:');
+    console.log('  init                  Set up Waymark in the current project');
+    console.log('  start [--port <n>]    Start the Waymark dashboard and MCP server');
+    console.log('  stop                  Stop the running Waymark servers');
+    console.log('  pause                 Pause a project (keep port allocated)');
+    console.log('  resume                Resume a paused project');
+    console.log('  status                Show current Waymark status and pending count');
+    console.log('  logs                  Show recent action log');
+    console.log('  list                  List all registered Waymark projects');
+    console.log('  open                  Open a project dashboard or start it');
+    console.log('');
+    console.log('Top-level flags:');
+    console.log('  -v, --version         Print the installed version');
+    console.log('  -h, --help            Show this help');
+    console.log('');
+    console.log('Notes:');
+    console.log('  • Default port range is 47000-47999 (avoids collisions with dev servers).');
+    console.log('  • Pin a port per-project: add "port": 47100 to waymark.config.json.');
+    console.log('  • Override at runtime: waymark start --port 47200');
+}
 const command = process.argv[2];
+// Top-level flags / aliases handled before the command switch so that
+// `waymark -v`, `waymark --version`, and `waymark version` all work.
+if (command === '-v' || command === '--version' || command === 'version') {
+    printVersion();
+    process.exit(0);
+}
+if (command === '-h' || command === '--help' || command === 'help' || command === undefined) {
+    printHelp();
+    process.exit(command === undefined ? 0 : 0);
+}
 switch (command) {
     case 'init':
         require('./commands/init').run();
@@ -30,22 +81,7 @@ switch (command) {
         require('./commands/open').run();
         break;
     default:
-        console.log('Usage: npx @way_marks/cli <init|start|stop|pause|resume|status|logs|list|open>');
-        console.log('');
-        console.log('Commands:');
-        console.log('  init                  Set up Waymark in the current project');
-        console.log('  start [--port <n>]    Start the Waymark dashboard and MCP server');
-        console.log('  stop                  Stop the running Waymark servers');
-        console.log('  pause                 Pause a project (keep port allocated)');
-        console.log('  resume                Resume a paused project');
-        console.log('  status                Show current Waymark status and pending count');
-        console.log('  logs                  Show recent action log');
-        console.log('  list                  List all registered Waymark projects');
-        console.log('  open                  Open a project dashboard or start it');
-        console.log('');
-        console.log('Notes:');
-        console.log('  • Default port range is 47000-47999 (avoids collisions with dev servers).');
-        console.log('  • Pin a port per-project: add "port": 47100 to waymark.config.json.');
-        console.log('  • Override at runtime: waymark start --port 47200');
-        process.exit(command ? 1 : 0);
+        console.error(`Unknown command: ${command}`);
+        console.error('Run "waymark --help" for usage.');
+        process.exit(1);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@way_marks/cli",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "description": "Control what AI agents can do in your codebase",
   "author": "Waymark <hello@waymarks.dev>",
   "license": "MIT",
@@ -22,15 +22,18 @@
     "agent-control"
   ],
   "bin": {
-    "waymark": "./dist/index.js"
+    "waymark": "./dist/index.js",
+    "way_marks": "./dist/index.js"
   },
   "files": [
-    "dist/**"
+    "dist/**",
+    "scripts/postinstall.js"
   ],
   "scripts": {
     "build": "tsc",
     "test": "jest",
-    "test:coverage": "jest --coverage"
+    "test:coverage": "jest --coverage",
+    "postinstall": "node scripts/postinstall.js"
   },
   "jest": {
     "preset": "ts-jest",
@@ -40,7 +43,7 @@
     ]
   },
   "dependencies": {
-    "@way_marks/server": "4.0.0"
+    "@way_marks/server": "4.0.2"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",

package/scripts/postinstall.js

@@ -0,0 +1,44 @@
+#!/usr/bin/env node
+/**
+ * Friendly post-install banner.
+ *
+ * Runs only when @way_marks/cli is installed globally (so it doesn't
+ * spam users who add it as a dev-dep). Anything that goes wrong is
+ * silently swallowed — postinstall must never fail the install.
+ */
+
+try {
+  // npm sets npm_config_global=true for `npm i -g`. We only want the banner
+  // for global installs; in dev (added as a dep) it would be noise.
+  const isGlobal =
+    process.env.npm_config_global === 'true' ||
+    process.env.npm_global === 'true';
+  if (!isGlobal) process.exit(0);
+
+  // Skip in CI to avoid spamming logs. Don't gate on isTTY — npm pipes child
+  // stdout through itself during install, so isTTY is always false even when
+  // the user is at an interactive terminal.
+  if (process.env.CI) process.exit(0);
+
+  const pkg = require('../package.json');
+  const version = pkg.version || 'unknown';
+
+  const lines = [
+    '',
+    `  ✓ @way_marks/cli@${version} installed.`,
+    '',
+    '    Run:  waymark init     — set up Waymark in your current project',
+    '          waymark start    — launch the dashboard + MCP server',
+    '          waymark --help   — full command list',
+    '',
+    '    Tip: the binary is `waymark` (also accepts `way_marks`).',
+    '',
+  ];
+  // Write to stderr so npm forwards it reliably during global install.
+  // (npm buffers install-script stdout at the default log level; stderr is
+  // surfaced as a notice.)
+  for (const l of lines) process.stderr.write(l + '\n');
+} catch {
+  // never block npm install on banner failure
+  process.exit(0);
+}