artifacty 0.7.0 → 0.8.0

package/README.md

@@ -82,6 +82,13 @@ artifacty install all
 artifacty check
 ```
 
+Run diagnostics for the local runtime, store, server, service definitions, and MCP discovery:
+
+```bash
+artifacty doctor
+artifacty doctor --skip-mcp
+```
+
 Use `artifacty install codex --timeout 30000` or
 `artifacty install gemini --timeout 30000` to tune supported MCP client timeouts.
 
@@ -190,6 +197,7 @@ Operational commands:
 
 ```bash
 artifacty audit --limit 20
+artifacty doctor
 artifacty index rebuild
 artifacty integrity
 artifacty backup

package/docs/integrations.md

@@ -37,6 +37,15 @@ The lifecycle commands are intended to be cross-platform:
 - Windows: `start` hides the child console window, and `stop` uses `taskkill /PID <pid> /T`, falling back to `/F` when Windows requires forceful termination. `--force` uses `/F` immediately.
 - All platforms: `status` combines the managed pid file with the HTTP `/health` endpoint, so a stale pid alone is not reported as healthy.
 
+Run diagnostics when setup behaves unexpectedly:
+
+```bash
+node src/cli.js doctor
+node src/cli.js doctor --skip-mcp
+```
+
+`doctor` checks Node version support, local exposure settings, store integrity, managed server health, service definition rendering, and MCP discovery. A stopped server is reported as a warning, not a failure.
+
 For login/startup persistence, use the operating system's service manager. Artifacty's `service` command can generate macOS LaunchAgent, Linux systemd user-unit, and Windows Task Scheduler definitions.
 
 Create artifacts directly in the browser at `http://127.0.0.1:8787/new`.
@@ -85,6 +94,7 @@ node src/cli.js check
 - `--dry-run` returns the generated config without writing it.
 - `--timeout <ms>` adjusts Codex `startup_timeout_sec` and Gemini `timeout`. It does not change Claude Code startup behavior; set `MCP_TIMEOUT` before launching Claude Code if you need a larger value there.
 - `check` starts the local MCP server and verifies required tools, resources, and prompts through MCP discovery methods.
+- `doctor` combines MCP discovery with runtime, storage, server, and service diagnostics.
 
 ## Client Compatibility Matrix
 

package/docs/release-checklist.md

@@ -10,6 +10,12 @@ npm run release:check
 
 This runs syntax checks, the full Node test suite, and a local smoke test that starts the HTTP server with token auth enabled, creates an artifact, verifies secret blocking, reads audit logs, writes a backup, and checks MCP tool/resource/prompt discovery.
 
+Run the local diagnostics pass:
+
+```bash
+artifacty doctor
+```
+
 ## Packaging
 
 - Confirm `package.json` `version` and `files` are intentional.
@@ -47,4 +53,5 @@ This runs syntax checks, the full Node test suite, and a local smoke test that s
 
 - Export a backup before upgrades: `artifacty backup`.
 - Confirm `artifacty audit --limit 20` shows recent create/update/read/archive events.
+- Confirm `artifacty doctor` reports no failures. A stopped server warning is acceptable when intentionally checking an offline store.
 - For background service installs, dry-run first: `artifacty service install --dry-run`. Use `--platform macos|linux|windows` to review another OS definition.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "artifacty",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Local artifact exchange for heterogeneous LLM agents via HTTP and MCP.",
   "type": "module",
   "keywords": [

package/src/cli.js

@@ -22,6 +22,7 @@ import { serviceCommand } from "./lib/service.js";
 import { backgroundStatus, startBackgroundServer, stopBackgroundServer } from "./lib/background.js";
 import { resolvePublicBaseUrl } from "./lib/server-state.js";
 import { generateToken } from "./lib/token.js";
+import { runDoctor } from "./lib/doctor.js";
 import { startServer } from "./server.js";
 
 const PACKAGE_ROOT = path.dirname(path.dirname(fileURLToPath(import.meta.url)));
@@ -105,6 +106,27 @@ async function main() {
     return;
   }
 
+  if (command === "doctor") {
+    const result = await runDoctor({
+      packageRoot: PACKAGE_ROOT,
+      serverPath: options.serverPath,
+      url: options.url,
+      home: options.home,
+      host: options.host,
+      port: options.port,
+      apiToken: options.apiToken,
+      shareMode: options.shareMode,
+      allowSecrets: options.allowSecrets,
+      timeout: options.timeout,
+      skipMcp: options.skipMcp
+    });
+    printJson(result);
+    if (!result.ok) {
+      process.exitCode = 1;
+    }
+    return;
+  }
+
   if (command === "publish") {
     const content = await readContent(options);
     const artifact = await createArtifact(store, {
@@ -324,7 +346,7 @@ function parseArgs(args) {
     }
 
     const key = arg.slice(2);
-    if (key === "raw" || key === "dry-run" || key === "trust" || key === "include-archived" || key === "allow-secrets" || key === "generate-token" || key === "detach" || key === "foreground" || key === "force") {
+    if (key === "raw" || key === "dry-run" || key === "trust" || key === "include-archived" || key === "allow-secrets" || key === "generate-token" || key === "detach" || key === "foreground" || key === "force" || key === "skip-mcp") {
       options[toCamelCase(key)] = true;
       continue;
     }
@@ -412,6 +434,7 @@ Usage:
   artifacty start [--host 127.0.0.1] [--port 8787] [--home ~/.artifacty] [--api-token token] [--generate-token] [--timeout 30000]
   artifacty status [--home ~/.artifacty]
   artifacty stop [--home ~/.artifacty] [--timeout 30000] [--force]
+  artifacty doctor [--home ~/.artifacty] [--skip-mcp] [--timeout 5000]
   artifacty publish --title <title> (--file <path> | --content <text>) [--format html|markdown|text|json|code|svg|mermaid|react] [--source agent] [--tag tag]
   artifacty import --agent claude|codex|gemini|copilot|cursor|auto (--file <path> | --content <text>) [--title <title>] [--format html|markdown|text|json|code|svg|mermaid|react] [--tag tag]
   artifacty install claude|codex|gemini|copilot|cursor|all [--dry-run] [--config <path>] [--server-path <path>] [--url http://127.0.0.1:8787] [--timeout 30000]

package/src/lib/doctor.js

@@ -0,0 +1,214 @@
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { arch, platform } from "node:os";
+import { backgroundStatus } from "./background.js";
+import { checkMcpTools } from "./check.js";
+import { securityConfig, validateServerExposure, exposureWarning } from "./security.js";
+import { serviceCommand } from "./service.js";
+import { checkStoreIntegrity, createStore } from "./storage.js";
+
+const MIN_NODE_VERSION = "22.5.0";
+
+export async function runDoctor(options = {}) {
+  const packageRoot = path.resolve(options.packageRoot || process.cwd());
+  const store = createStore({ home: options.home });
+  const checks = [];
+
+  await collect(checks, "runtime", () => runtimeCheck(packageRoot));
+  await collect(checks, "security", () => securityCheck(options));
+  await collect(checks, "storage", () => storageCheck(store));
+  await collect(checks, "server", () => serverCheck(store));
+  await collect(checks, "service", () => serviceCheck(options));
+  if (options.skipMcp) {
+    checks.push({
+      name: "mcp",
+      status: "skip",
+      message: "MCP discovery skipped by --skip-mcp"
+    });
+  } else {
+    await collect(checks, "mcp", () => mcpCheck(packageRoot, options));
+  }
+
+  const failures = checks.filter((check) => check.status === "fail");
+  const warnings = checks.filter((check) => check.status === "warn");
+
+  return {
+    ok: failures.length === 0,
+    checkedAt: new Date().toISOString(),
+    version: await packageVersion(packageRoot),
+    home: store.home,
+    platform: process.platform,
+    checks,
+    failures: failures.map(({ name, message }) => ({ name, message })),
+    warnings: warnings.map(({ name, message }) => ({ name, message }))
+  };
+}
+
+async function collect(checks, name, fn) {
+  try {
+    checks.push({ name, ...(await fn()) });
+  } catch (error) {
+    checks.push({
+      name,
+      status: "fail",
+      message: error.message,
+      error: {
+        name: error.name,
+        code: error.code
+      }
+    });
+  }
+}
+
+async function runtimeCheck(packageRoot) {
+  const version = await packageVersion(packageRoot);
+  const supported = compareVersions(process.versions.node, MIN_NODE_VERSION) >= 0;
+  return {
+    status: supported ? "pass" : "fail",
+    message: supported
+      ? `Node ${process.versions.node} satisfies >=${MIN_NODE_VERSION}`
+      : `Node ${process.versions.node} is below required >=${MIN_NODE_VERSION}`,
+    data: {
+      artifactyVersion: version,
+      nodeVersion: process.versions.node,
+      requiredNodeVersion: `>=${MIN_NODE_VERSION}`,
+      platform: platform(),
+      arch: arch()
+    }
+  };
+}
+
+function securityCheck(options = {}) {
+  const host = options.host || process.env.ARTIFACTY_HOST || "127.0.0.1";
+  const config = securityConfig(options);
+  validateServerExposure({ host, config });
+  const warning = exposureWarning({ host, config });
+  if (warning) {
+    return {
+      status: "warn",
+      message: warning,
+      data: {
+        host,
+        shareMode: config.shareMode,
+        hasApiToken: Boolean(config.apiToken)
+      }
+    };
+  }
+  return {
+    status: "pass",
+    message: "Server exposure settings are local-first",
+    data: {
+      host,
+      shareMode: config.shareMode,
+      hasApiToken: Boolean(config.apiToken)
+    }
+  };
+}
+
+async function storageCheck(store) {
+  const integrity = await checkStoreIntegrity(store);
+  return {
+    status: integrity.ok ? "pass" : "fail",
+    message: integrity.ok
+      ? `Store is consistent with ${integrity.artifactCount} artifacts and ${integrity.versionCount} versions`
+      : "Store integrity check found missing, changed, orphaned, or inconsistent files",
+    data: integrity
+  };
+}
+
+async function serverCheck(store) {
+  const status = await backgroundStatus({ home: store.home });
+  if (status.running) {
+    return {
+      status: "pass",
+      message: `Managed server is healthy at ${status.url}`,
+      data: status
+    };
+  }
+  if (status.processRunning || status.pidFileExists) {
+    return {
+      status: "fail",
+      message: "Recorded server process or pid file exists but health check is not passing",
+      data: status
+    };
+  }
+  return {
+    status: "warn",
+    message: "No managed Artifacty server is currently running",
+    data: status
+  };
+}
+
+async function serviceCheck(options = {}) {
+  const definitions = [];
+  for (const action of ["plist", "unit", "task"]) {
+    const result = await serviceCommand(action, {
+      projectDir: options.packageRoot || process.cwd(),
+      serverPath: options.serverPath,
+      host: options.host,
+      port: options.port,
+      home: options.home,
+      apiToken: options.apiToken,
+      shareMode: options.shareMode,
+      allowSecrets: options.allowSecrets,
+      dryRun: true
+    });
+    definitions.push({
+      action,
+      platform: result.platform,
+      path: result.path,
+      contentBytes: Buffer.byteLength(result.content || "", "utf8")
+    });
+  }
+  return {
+    status: "pass",
+    message: "Service definitions render for macOS, Linux, and Windows",
+    data: { definitions }
+  };
+}
+
+async function mcpCheck(packageRoot, options = {}) {
+  const result = await checkMcpTools({
+    projectDir: packageRoot,
+    serverPath: options.serverPath,
+    url: options.url,
+    home: options.home,
+    timeout: options.timeout
+  });
+  return {
+    status: result.ok ? "pass" : "fail",
+    message: result.ok
+      ? `MCP discovery found ${result.toolCount} tools, ${result.resourceCount} resources, and ${result.promptCount} prompts`
+      : "MCP discovery is missing required tools, resources, or prompts",
+    data: result
+  };
+}
+
+async function packageVersion(packageRoot) {
+  const file = path.join(packageRoot, "package.json");
+  const parsed = JSON.parse(await readFile(file, "utf8"));
+  return parsed.version;
+}
+
+function compareVersions(left, right) {
+  const leftParts = versionParts(left);
+  const rightParts = versionParts(right);
+  for (let index = 0; index < Math.max(leftParts.length, rightParts.length); index += 1) {
+    const leftPart = leftParts[index] || 0;
+    const rightPart = rightParts[index] || 0;
+    if (leftPart > rightPart) {
+      return 1;
+    }
+    if (leftPart < rightPart) {
+      return -1;
+    }
+  }
+  return 0;
+}
+
+function versionParts(value) {
+  return String(value)
+    .split(".")
+    .map((part) => Number.parseInt(part, 10))
+    .filter((part) => Number.isFinite(part));
+}