@genrtl/grtl 0.4.0 → 1.0.0

package/README.md

@@ -32,9 +32,18 @@ grtl setup --mcp --codex
 grtl setup --mcp --cursor --project
 ```
 
-Without `--cli` or `--mcp`, setup asks which mode to install.
-
-For Codex, Skills are installed under `.agents/skills` for project setup or
+Without `--cli` or `--mcp`, setup asks which mode to install.
+
+Installing a newer npm package does not modify Skills already written to an
+agent configuration directory. Run the matching setup command again after an
+upgrade to refresh the Skill. For example:
+
+```bash
+grtl setup --cli --cursor
+grtl setup --cli --cursor --project
+```
+
+For Codex, Skills are installed under `.agents/skills` for project setup or
 `~/.agents/skills` for global setup. MCP mode also updates
 `.codex/config.toml` or `~/.codex/config.toml`.
 
@@ -48,13 +57,14 @@ https://genrtl.com/api/mcp
 
 ```bash
 grtl knowledge-search "AXI stream backpressure design"
-grtl spec2rtl-search "Design an APB register block"
-grtl spec2plan-search "Plan an APB register block implementation"
-grtl verification-search "Verify an async FIFO"
-grtl debug-search "Explain this Vivado CDC warning"
-```
-
-Use `--json` for structured output. `--type` accepts `spec2rtl`, `spec2plan`, `verification`, or `debug`; other filters include
+grtl spec2rtl-search "Design an APB register block"
+grtl spec2plan-search "Plan an APB register block implementation"
+grtl verification-search "Verify an async FIFO"
+grtl compile-search "Explain this Vivado CDC warning"
+grtl debug-search "Fix this RTL bug from bad code and error message"
+```
+
+Use `--json` for structured output. `--type` accepts `spec2rtl`, `spec2plan`, `verification`, `compile`, `debug`, or `coding_style`; other filters include
 `--domain`, `--tool`, `--tool-version`, `--error-type`, `--severity`,
 `--interface`, `--target`, `--tag`, `--top-k`, `--min-score`, and
 `--workspace-id`.

package/dist/index.js

@@ -378,18 +378,24 @@ Choose one tool:
 - \`genrtl_spec2rtl_search\` for requirements and RTL design
 - \`genrtl_spec2plan_search\` for implementation planning from a specification
 - \`genrtl_verification_search\` for testbenches and verification
-- \`genrtl_debug_search\` for lint, CDC, compile, synthesis, and RTL bugs
+- \`genrtl_compile_search\` for lint, CDC, compile, synthesis, implementation, and simulator diagnostics
+- \`genrtl_debug_search\` for issue descriptions, erroneous code, solutions, and corrected RTL
 
 Pass the complete engineering question in \`query\`. Add filters only when useful.`;
-var FALLBACK_CLI = `Use the \`grtl\` CLI for grounded RTL engineering knowledge.
+var FALLBACK_CLI = `Use the \`grtl\` CLI for grounded RTL engineering knowledge and reusable CBB installation.
 
-Choose one command:
+For knowledge retrieval, choose one command:
 - \`npx @genrtl/grtl@latest knowledge-search "<query>"\`
 - \`npx @genrtl/grtl@latest spec2rtl-search "<query>"\`
 - \`npx @genrtl/grtl@latest spec2plan-search "<query>"\`
 - \`npx @genrtl/grtl@latest verification-search "<query>"\`
+- \`npx @genrtl/grtl@latest compile-search "<query>"\`
 - \`npx @genrtl/grtl@latest debug-search "<query>"\`
 
+To install a reusable RTL block into the current project:
+- \`npx @genrtl/grtl@latest cbb install <cbb_id>@<version>\`
+- Add \`--target <relative-dir>\` only when a non-default install path is needed.
+
 Pass the complete engineering question. Add filters such as \`--tool\`,
 \`--tool-version\`, \`--target\`, \`--interface\`, or \`--tag\` when known.
 If authentication fails, set \`GRTL_API_KEY\` or \`GENRTL_API_KEY\` in the
@@ -402,7 +408,7 @@ alwaysApply: true
 var CODEX_CLI_SANDBOX_GUIDANCE = `Run GenRTL CLI requests outside Codex's default sandbox. If a GenRTL CLI command fails with DNS or network errors such as ENOTFOUND, host resolution failures, or fetch failed, rerun it outside the sandbox instead of retrying inside the sandbox.`;
 var MCP_SKILL = `---
 name: genrtl-mcp
-description: Use GenRTL MCP tools for grounded RTL design, verification, lint, CDC, synthesis, compile, and debugging knowledge.
+description: Use GenRTL MCP tools for grounded RTL design, verification, compile/synthesis diagnostics, debugging, and coding style knowledge.
 ---
 
 # GenRTL MCP
@@ -415,28 +421,36 @@ Choose exactly one MCP tool:
 - \`genrtl_spec2rtl_search\` for requirements, protocols, control logic, or algorithm-to-RTL work.
 - \`genrtl_spec2plan_search\` for turning a specification into an actionable implementation plan.
 - \`genrtl_verification_search\` for testbenches and verification.
-- \`genrtl_debug_search\` for lint, CDC, compile, synthesis, or RTL bugs.
+- \`genrtl_compile_search\` for lint, CDC, compile, synthesis, implementation, or simulator diagnostics.
+- \`genrtl_debug_search\` for issue descriptions, erroneous code, solutions, and corrected RTL.
 
 Pass the complete engineering question in \`query\`. Add \`filters\`, \`top_k\`,
 \`min_score\`, or \`workspace_id\` only when useful.
 `;
 var CLI_SKILL = `---
 name: genrtl-cli
-description: Use the grtl CLI for grounded RTL design, verification, lint, CDC, synthesis, compile, and debugging knowledge.
+description: Use the grtl CLI for grounded RTL design, verification, compile/synthesis diagnostics, debugging knowledge, and secure installation of reusable RTL CBBs.
 ---
 
 # GenRTL CLI
 
-Use this skill when an RTL engineering task needs grounded GenRTL knowledge and
-the GenRTL MCP server is not configured.
+Use this skill when an RTL engineering task needs grounded GenRTL knowledge or
+a reusable CBB must be installed into the user's local project.
 
-Choose exactly one command:
+For knowledge retrieval, choose exactly one command:
 
 - \`grtl knowledge-search "<query>" --json\` for cross-domain RTL questions.
 - \`grtl spec2rtl-search "<query>" --json\` for requirements, protocols, control logic, or algorithm-to-RTL work.
 - \`grtl spec2plan-search "<query>" --json\` for turning a specification into an actionable implementation plan.
 - \`grtl verification-search "<query>" --json\` for testbenches and verification.
-- \`grtl debug-search "<query>" --json\` for lint, CDC, compile, synthesis, or RTL bugs.
+- \`grtl compile-search "<query>" --json\` for lint, CDC, compile, synthesis, implementation, or simulator diagnostics.
+- \`grtl debug-search "<query>" --json\` for issue descriptions, erroneous code, solutions, and corrected RTL.
+
+For a CBB selected from GenRTL search results:
+
+- \`grtl cbb install <cbb_id>@<version>\` downloads, verifies, and safely extracts it.
+- Add \`--target <relative-dir>\` only when the user requests a specific project path.
+- Do not download or extract the artifact manually; the CLI verifies SHA-256 and prevents unsafe ZIP paths.
 
 Pass the complete engineering question. Add filters such as \`--tool\`,
 \`--tool-version\`, \`--target\`, \`--interface\`, or \`--tag\` only when useful.
@@ -972,10 +986,15 @@ var TOOL_COMMANDS = [
     alias: "verification-search",
     description: "Search verification and testbench knowledge cards"
   },
+  {
+    name: "genrtl_compile_search",
+    alias: "compile-search",
+    description: "Search compile, lint, CDC, synthesis, implementation, and simulator diagnostic knowledge cards"
+  },
   {
     name: "genrtl_debug_search",
     alias: "debug-search",
-    description: "Search lint, CDC, compile, synthesis, and RTL debug knowledge cards"
+    description: "Search RTL debug cards with issue description, erroneous code, solution, and corrected code"
   }
 ];
 function parseInteger(value) {
@@ -1004,7 +1023,14 @@ function buildKnowledgeSearchInput(query, options) {
   }
   const filters = {};
   if (options.type?.length) {
-    const allowed = /* @__PURE__ */ new Set(["spec2rtl", "spec2plan", "verification", "debug"]);
+    const allowed = /* @__PURE__ */ new Set([
+      "spec2rtl",
+      "spec2plan",
+      "verification",
+      "compile",
+      "debug",
+      "coding_style"
+    ]);
     const invalid = options.type.find((type) => !allowed.has(type));
     if (invalid) {
       throw new InvalidArgumentError(`Invalid knowledge type: ${invalid}`);
@@ -1081,7 +1107,10 @@ function printKnowledgeResult(result) {
   }
 }
 function addSearchOptions(command) {
-  return command.argument("<query>", "Natural-language RTL engineering question or diagnostic").option("--type <type...>", "Knowledge types: spec2rtl, spec2plan, verification, debug").option("--domain <domain>", "Filter by engineering domain").option("--tool <tool>", "Filter by EDA tool").option("--tool-version <version>", "Filter by EDA tool version").option("--error-type <type>", "Filter by error type").option("--severity <severity>", "Filter by severity").option("--interface <interface>", "Filter by hardware interface").option("--target <target>", "Filter by target: fpga, asic, or both").option("--tag <tag...>", "Filter by one or more tags").option("--top-k <count>", "Maximum results (1-20)", parseInteger).option("--min-score <score>", "Minimum similarity score (0-1)", parseNumber).option("--workspace-id <id>", "GenRTL workspace ID").option("--json", "Output the structured MCP result as JSON");
+  return command.argument("<query>", "Natural-language RTL engineering question or diagnostic").option(
+    "--type <type...>",
+    "Knowledge types: spec2rtl, spec2plan, verification, compile, debug, coding_style"
+  ).option("--domain <domain>", "Filter by engineering domain").option("--tool <tool>", "Filter by EDA tool").option("--tool-version <version>", "Filter by EDA tool version").option("--error-type <type>", "Filter by error type").option("--severity <severity>", "Filter by severity").option("--interface <interface>", "Filter by hardware interface").option("--target <target>", "Filter by target: fpga, asic, or both").option("--tag <tag...>", "Filter by one or more tags").option("--top-k <count>", "Maximum results (1-20)", parseInteger).option("--min-score <score>", "Minimum similarity score (0-1)", parseNumber).option("--workspace-id <id>", "GenRTL workspace ID").option("--json", "Output the structured MCP result as JSON");
 }
 function registerKnowledgeCommands(program2) {
   for (const tool of TOOL_COMMANDS) {
@@ -1901,12 +1930,13 @@ Examples:
   ${brand.primary("npx @genrtl/grtl setup --cli --codex --project")}
   ${brand.primary("GRTL_API_KEY=your_key npx @genrtl/grtl setup --mcp --codex --project")}
 
-  ${brand.dim("# Search the same five tools exposed by the GenRTL MCP server")}
+  ${brand.dim("# Search the same six knowledge tools exposed by the GenRTL MCP server")}
   ${brand.primary('npx @genrtl/grtl knowledge-search "AXI stream backpressure design"')}
   ${brand.primary('npx @genrtl/grtl spec2rtl-search "Generate an APB register block"')}
   ${brand.primary('npx @genrtl/grtl spec2plan-search "Plan an APB register block implementation"')}
   ${brand.primary('npx @genrtl/grtl verification-search "Verify an async FIFO"')}
-  ${brand.primary('npx @genrtl/grtl debug-search "Explain this Vivado CDC warning"')}
+  ${brand.primary('npx @genrtl/grtl compile-search "Explain this Vivado CDC warning"')}
+  ${brand.primary('npx @genrtl/grtl debug-search "Fix this RTL bug from bad code and error message"')}
 
   ${brand.dim("# Acquire and install a reusable RTL CBB")}
   ${brand.primary("npx @genrtl/grtl cbb install cbb_uart@1.2.0")}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@genrtl/grtl",
-  "version": "0.4.0",
+  "version": "1.0.0",
   "description": "CLI, MCP, and coding-agent Skills for GenRTL RTL engineering knowledge",
   "type": "module",
   "bin": {