create-guardio 0.0.6 → 0.0.8

package/index.mjs

@@ -21,32 +21,80 @@ function ask(question, defaultAnswer = "") {
   });
 }
 
+function askYesNo(question, defaultAnswer = "n") {
+  return ask(question + " (y/n)", defaultAnswer).then((a) =>
+    /^y(es)?|1$/i.test(a),
+  );
+}
+
 async function main() {
   console.log("\nCreate Guardio\n");
 
-  const guardioDir = await ask("Guardio directory", "./mcp-server-gated");
+  const guardioDir = await ask("Guardio directory", "guardio-project");
   const guardioPath = resolve(process.cwd(), guardioDir);
 
-  const url = await ask("MCP server URL", "https://example.com/mcp");
   const portStr = await ask("Guardio HTTP server port", "3939");
   const port = parseInt(portStr, 10) || 3939;
 
+  const useStorage = await askYesNo(
+    "Use storage and events (for dashboard / policy state)?",
+    "n",
+  );
+
+  // All built-in policy plugins by default
+  const plugins = [
+    { type: "policy", name: "deny-tool-access" },
+    { type: "policy", name: "deny-regex-parameter" },
+  ];
+
+  if (useStorage) {
+    console.log("  1) sqlite (in-memory or file)");
+    console.log("  2) postgres");
+    const storageBackend = await ask("Storage backend (1-2)", "1");
+    if (storageBackend === "2") {
+      const pgConnectionString = await ask(
+        "PostgreSQL connection string",
+        "postgresql://localhost:5432/guardio",
+      );
+      const pgConfig = { connectionString: pgConnectionString };
+      plugins.push({ type: "storage", name: "postgres", config: pgConfig });
+      plugins.push({ type: "eventSink", name: "postgres" });
+      plugins.push({ type: "eventSinkStore", name: "postgres" });
+    } else {
+      const sqliteInMemory = await askYesNo(
+        "Use in-memory SQLite? (y = in-memory, n = file guardio.sqlite)",
+        "y",
+      );
+      const sqliteConfig = sqliteInMemory
+        ? { inMemory: true }
+        : { database: "guardio.sqlite" };
+      plugins.push({ type: "storage", name: "sqlite", config: sqliteConfig });
+      plugins.push({ type: "eventSink", name: "sqlite", config: sqliteConfig });
+      plugins.push({
+        type: "eventSinkStore",
+        name: "sqlite",
+        config: sqliteConfig,
+      });
+    }
+  }
+
+  const addExamplePlugin = await askYesNo(
+    "Add example custom policy plugin?",
+    "n",
+  );
+  if (addExamplePlugin) {
+    plugins.push({ type: "policy", name: "example", path: "./plugins/example" });
+  }
+
+  const installDashboard = await askYesNo("Install dashboard?", "n");
+
   const config = {
-    server: { type: "url", url },
-    client: { mode: "http", port, host: "127.0.0.1" },
-    plugins: [
-      { type: "policy", name: "default", config: { blockedTools: [] } },
-      {
-        type: "policy",
-        name: "example",
-        path: "./plugins/example",
-        config: {},
-      },
-    ],
+    servers: [],
+    client: { port, host: "127.0.0.1" },
+    plugins,
   };
 
   await mkdir(guardioPath, { recursive: true });
-  await mkdir(resolve(guardioPath, "plugins", "example"), { recursive: true });
 
   const packageJson = {
     name: "guardio-project",
@@ -55,7 +103,8 @@ async function main() {
     description: "Guardio-gated MCP server with optional local plugins",
     scripts: {
       build: "tsc",
-      guardio: "node --import tsx ./node_modules/@guardiojs/guardio/dist/cli.js --config guardio.config.ts",
+      guardio:
+        "node --import tsx ./node_modules/@guardiojs/guardio/dist/cli.js --config guardio.config.ts",
     },
     dependencies: { "@guardiojs/guardio": "*" },
     devDependencies: {
@@ -64,6 +113,10 @@ async function main() {
       tsx: "^4.19.0",
     },
   };
+  if (installDashboard) {
+    packageJson.dependencies["@guardiojs/dashboard"] = "*";
+    packageJson.scripts.dashboard = "dashboard";
+  }
   await writeFile(
     resolve(guardioPath, "package.json"),
     JSON.stringify(packageJson, null, 2),
@@ -89,6 +142,9 @@ async function main() {
 
   const configTsContent = `import type { GuardioConfig } from "@guardiojs/guardio";
 
+// Example server (uncomment and add to servers array to proxy an MCP server):
+// { name: "nuvei-docs", type: "url", url: "https://mcp.nuvei.com/sse" }
+
 const config: GuardioConfig = ${JSON.stringify(config, null, 2).replace(/^/gm, "  ")};
 
 export default config;
@@ -99,7 +155,9 @@ export default config;
     "utf-8",
   );
 
-  const examplePluginContent = `import type {
+  if (addExamplePlugin) {
+    await mkdir(resolve(guardioPath, "plugins", "example"), { recursive: true });
+    const examplePluginContent = `import type {
   PolicyPluginInterface,
   PolicyRequestContext,
   PolicyResult,
@@ -113,32 +171,31 @@ export default config;
 class ExamplePolicyPlugin implements PolicyPluginInterface {
   readonly name = "example";
 
-  evaluate(context: PolicyRequestContext): PolicyResult {
+  async evaluate(context: PolicyRequestContext): Promise<PolicyResult> {
     // Example: allow all calls. Replace with your policy logic.
-    return "allowed";
+    return Promise.resolve({ verdict: "allow" });
   }
 }
 
 export default new ExamplePolicyPlugin();
 `;
+    await writeFile(
+      resolve(guardioPath, "plugins", "example", "index.ts"),
+      examplePluginContent,
+      "utf-8",
+    );
+  }
 
-  await writeFile(
-    resolve(guardioPath, "plugins", "example", "index.ts"),
-    examplePluginContent,
-    "utf-8",
-  );
-
+  await mkdir(resolve(guardioPath, "plugins"), { recursive: true });
   const pluginsReadme = `# Custom plugins (path-based)
 
 Add a plugin by setting \`path\` in \`guardio.config.ts\` to a directory that contains \`index.js\` or \`index.mjs\` (compile from \`index.ts\` with \`npm run build\`).
 
 - The directory must have \`index.js\` or \`index.mjs\` whose **default export is the plugin instance** (no descriptor).
-- Policy: implement \`PolicyPluginInterface\` (name, evaluate). Config: \`{ "type": "policy", "name": "my-policy", "path": "./plugins/my-policy" }\`.
-- Intervention: implement \`InterventionPluginInterface\` (name, act). Config: \`{ "type": "intervention", "name": "my-intervention", "path": "./plugins/my-intervention" }\`.
+- Policy: implement \`PolicyPluginInterface\` (name, evaluate returning Promise<PolicyResult>). Config: \`{ "type": "policy", "name": "my-policy", "path": "./plugins/my-policy" }\`.
 
-Import types from "@guardiojs/guardio". See example/ for a policy plugin.
+Import types from "@guardiojs/guardio".${addExamplePlugin ? " See example/ for a policy plugin." : ""}
 `;
-
   await writeFile(
     resolve(guardioPath, "plugins", "README.md"),
     pluginsReadme,
@@ -147,13 +204,23 @@ Import types from "@guardiojs/guardio". See example/ for a policy plugin.
 
   console.log("\n---\n");
   console.log("Next steps");
-  console.log("  cd " + guardioDir + " && npm install");
-  console.log("  npm run build   # compile plugins (index.ts → index.js)");
+  console.log("  cd " + guardioDir);
+  console.log(
+    "  npm install   # or: pnpm install, yarn, bun install, etc.",
+  );
+  if (addExamplePlugin) {
+    console.log("  npm run build   # compile plugins (index.ts → index.js)");
+  }
   console.log("");
   console.log("Run Guardio as HTTP server:");
-  console.log("  pnpm guardio");
-  console.log("  (uses tsx so guardio.config.ts loads without compiling)");
+  console.log("  npm run guardio");
   console.log("");
+  if (installDashboard) {
+    console.log("Run dashboard (point it at Guardio URL):");
+    console.log("  pnpm run dashboard   # or: npm run dashboard");
+    console.log("  # Guardio base URL: http://127.0.0.1:" + port);
+    console.log("");
+  }
   console.log("Add to MCP client (use URL):");
   console.log('  "url": "http://127.0.0.1:' + port + '"');
   console.log("");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-guardio",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Scaffold a Guardio project",
   "type": "module",
   "bin": {