@ghostbyte/agent-docs-kit 4.0.2 → 4.0.3

package/README.md

@@ -32,6 +32,7 @@ npx @ghostbyte/agent-docs-kit@latest list security
 npx @ghostbyte/agent-docs-kit@latest audit security api-layer --style learning
 npx @ghostbyte/agent-docs-kit@latest review engineering testing-types
 npx @ghostbyte/agent-docs-kit@latest skill install --target project
+npx @ghostbyte/agent-docs-kit@latest website
 ```
 
 Installing the package performs no setup and changes no project files. Mutation happens only after an explicit command:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ghostbyte/agent-docs-kit",
-  "version": "4.0.2",
+  "version": "4.0.3",
   "description": "Documentation governance, evidence-based security audits, and engineering-quality reviews for software projects.",
   "type": "module",
   "bin": {

package/src/api/index.mjs

@@ -1,4 +1,5 @@
 export { setupProject } from "../commands/setup.mjs";
 export { auditDocumentation, auditSecurity, reviewEngineering } from "../commands/audit.mjs";
 export { installSkill } from "../commands/skill.mjs";
+export { openWebsite, websiteUrl } from "../commands/website.mjs";
 export { loadCatalog } from "../core/catalog.mjs";

package/src/cli/help.mjs

@@ -1,17 +1,32 @@
 export const helpText = `Agent Docs & Quality Kit
 
-Usage:
-  agent-docs                         Open the guided menu (TTY only)
-  agent-docs setup [--dry-run]       Install the documentation workspace
-  agent-docs audit documentation     Check documentation health
-  agent-docs audit security [phase]  Create an evidence-based security worksheet
-  agent-docs review engineering [topic]
-                                     Create an engineering review worksheet
-  agent-docs list [security|engineering]
-  agent-docs skill install [--target project|codex] [--dry-run]
-  agent-docs validate                Validate this package's catalog and skill
-  agent-docs doctor                  Check local prerequisites
-  agent-docs --version               Show the package version
+Run without installing:
+  npx @ghostbyte/agent-docs-kit@latest [command] [options]
+
+After installing in a project:
+  npx agent-docs [command] [options]
+
+Commands:
+  (no command)                       Open the guided menu (TTY only)
+  setup [--dry-run]                  Install the documentation workspace
+  audit documentation                Check documentation health
+  audit security [phase]             Create an evidence-based security worksheet
+  review engineering [topic]         Create an engineering review worksheet
+  list [security|engineering]        List available phases or topics
+  skill install [--target project|codex] [--dry-run]
+                                     Install the unified quality skill
+  validate                           Validate the package catalog and skill
+  doctor                             Check local prerequisites
+  website                            Open the documentation website
+  --version                          Show the package version
+
+Examples:
+  npx @ghostbyte/agent-docs-kit@latest setup --dry-run
+  npx @ghostbyte/agent-docs-kit@latest audit documentation
+  npx @ghostbyte/agent-docs-kit@latest audit security api-layer
+  npx @ghostbyte/agent-docs-kit@latest review engineering testing-types
+  npx @ghostbyte/agent-docs-kit@latest skill install --target project
+  npx @ghostbyte/agent-docs-kit@latest website
 
 Options:
   --cwd <path>             Target project (default: current directory)

package/src/cli/main.mjs

@@ -8,13 +8,14 @@ import { listCatalog } from "../commands/list.mjs";
 import { installSkill } from "../commands/skill.mjs";
 import { doctor } from "../commands/doctor.mjs";
 import { validatePackage } from "../commands/validate.mjs";
+import { openWebsite } from "../commands/website.mjs";
 import { readFile } from "node:fs/promises";
 import { resolveFromPackage } from "../core/paths.mjs";
 
 async function menu() {
   const ui = createInterface({ input: stdin, output: stdout });
   try {
-    console.log(`\nAgent Docs & Quality Kit\n\n1. Set up documentation\n2. Audit documentation\n3. Start security audit\n4. Start engineering review\n5. Install project skill\n6. Validate package\n0. Exit`);
+    console.log(`\nAgent Docs & Quality Kit\n\n1. Set up documentation\n2. Audit documentation\n3. Start security audit\n4. Start engineering review\n5. Install project skill\n6. Validate package\n7. Open documentation website\n0. Exit`);
     const choice = await ui.question("\nChoose an action: ");
     if (choice === "1") return setupProject();
     if (choice === "2") return auditDocumentation();
@@ -28,6 +29,7 @@ async function menu() {
     }
     if (choice === "5") return installSkill("project");
     if (choice === "6") return validatePackage();
+    if (choice === "7") return openWebsite();
     if (choice !== "0") throw new Error("Unknown menu choice.");
   } finally {
     ui.close();
@@ -57,6 +59,7 @@ export async function main(argv) {
   if (command === "list") return listCatalog(subject);
   if (command === "skill" && subject === "install") return installSkill(flags.target ?? "project", options);
   if (command === "validate") return validatePackage();
+  if (command === "website") return openWebsite();
   if (command === "doctor") {
     if (!doctor()) process.exitCode = 1;
     return;

package/src/commands/website.mjs

@@ -0,0 +1,26 @@
+import { spawn } from "node:child_process";
+
+export const websiteUrl = "https://ghostbyte1014.github.io/Agent_Docs_Kit/";
+
+export function browserCommand(platform = process.platform) {
+  if (platform === "win32") {
+    return { executable: "cmd.exe", arguments: ["/d", "/s", "/c", `start "" "${websiteUrl}"`] };
+  }
+  if (platform === "darwin") return { executable: "open", arguments: [websiteUrl] };
+  return { executable: "xdg-open", arguments: [websiteUrl] };
+}
+
+export function openWebsite({ platform = process.platform, spawnProcess = spawn } = {}) {
+  const command = browserCommand(platform);
+  const child = spawnProcess(command.executable, command.arguments, {
+    detached: true,
+    stdio: "ignore",
+    windowsHide: true
+  });
+  child.once("error", () => {
+    console.error(`Could not open a browser. Visit: ${websiteUrl}`);
+  });
+  child.unref();
+  console.log(`Opening documentation: ${websiteUrl}`);
+  return websiteUrl;
+}