@genrtl/grtl 0.2.0 → 0.3.0

package/README.md

@@ -1,69 +1,70 @@
-# @genrtl/grtl
-
-CLI and coding-agent integration for the GenRTL RTL engineering knowledge
-service.
-
-## Install
-
-```bash
-npm install --global @genrtl/grtl
-export GRTL_API_KEY="gtr_live_your_api_key"
-```
-
-PowerShell:
-
-```powershell
-$env:GRTL_API_KEY = "gtr_live_your_api_key"
-```
-
-## Agent Setup
-
-Install a Skill that tells the agent to call the `grtl` CLI:
-
-```bash
-grtl setup --cli --codex
-grtl setup --cli --cursor --project
-```
-
-Configure hosted MCP and install a Skill for the four MCP tools:
-
-```bash
-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
-`~/.agents/skills` for global setup. MCP mode also updates
-`.codex/config.toml` or `~/.codex/config.toml`.
-
-The hosted MCP endpoint is:
-
-```text
-https://genrtl.com/api/mcp
-```
-
-## Knowledge Commands
-
-```bash
-grtl knowledge-search "AXI stream backpressure design"
-grtl spec2rtl-search "Design an APB register block"
-grtl verification-search "Verify an async FIFO"
-grtl debug-search "Explain this Vivado CDC warning"
-```
-
-Use `--json` for structured output. Available filters include `--type`,
-`--domain`, `--tool`, `--tool-version`, `--error-type`, `--severity`,
-`--interface`, `--target`, `--tag`, `--top-k`, `--min-score`, and
-`--workspace-id`.
-
-## Development
-
-```bash
-pnpm install
-pnpm --filter @genrtl/grtl lint:check
-pnpm --filter @genrtl/grtl typecheck
-pnpm --filter @genrtl/grtl test
-pnpm --filter @genrtl/grtl build
-```
+# @genrtl/grtl
+
+CLI and coding-agent integration for the GenRTL RTL engineering knowledge
+service.
+
+## Install
+
+```bash
+npm install --global @genrtl/grtl
+export GRTL_API_KEY="gtr_live_your_api_key"
+```
+
+PowerShell:
+
+```powershell
+$env:GRTL_API_KEY = "gtr_live_your_api_key"
+```
+
+## Agent Setup
+
+Install a Skill that tells the agent to call the `grtl` CLI:
+
+```bash
+grtl setup --cli --codex
+grtl setup --cli --cursor --project
+```
+
+Configure hosted MCP and install a Skill for the four MCP tools:
+
+```bash
+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
+`~/.agents/skills` for global setup. MCP mode also updates
+`.codex/config.toml` or `~/.codex/config.toml`.
+
+The hosted MCP endpoint is:
+
+```text
+https://genrtl.com/api/mcp
+```
+
+## Knowledge Commands
+
+```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
+`--domain`, `--tool`, `--tool-version`, `--error-type`, `--severity`,
+`--interface`, `--target`, `--tag`, `--top-k`, `--min-score`, and
+`--workspace-id`.
+
+## Development
+
+```bash
+pnpm install
+pnpm --filter @genrtl/grtl lint:check
+pnpm --filter @genrtl/grtl typecheck
+pnpm --filter @genrtl/grtl test
+pnpm --filter @genrtl/grtl build
+```

package/dist/index.js

@@ -376,6 +376,7 @@ var FALLBACK_MCP = `Use GenRTL MCP tools for grounded RTL engineering knowledge.
 Choose one tool:
 - \`genrtl_knowledge_search\` for cross-domain RTL questions
 - \`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
 
@@ -385,6 +386,7 @@ var FALLBACK_CLI = `Use the \`grtl\` CLI for grounded RTL engineering knowledge.
 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 debug-search "<query>"\`
 
@@ -411,6 +413,7 @@ Choose exactly one MCP tool:
 
 - \`genrtl_knowledge_search\` for cross-domain RTL questions.
 - \`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.
 
@@ -431,6 +434,7 @@ 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.
 
@@ -951,6 +955,11 @@ var TOOL_COMMANDS = [
     alias: "spec2rtl-search",
     description: "Search Spec2RTL knowledge cards"
   },
+  {
+    name: "genrtl_spec2plan_search",
+    alias: "spec2plan-search",
+    description: "Search Spec2Plan knowledge cards"
+  },
   {
     name: "genrtl_verification_search",
     alias: "verification-search",
@@ -988,7 +997,7 @@ function buildKnowledgeSearchInput(query, options) {
   }
   const filters = {};
   if (options.type?.length) {
-    const allowed = /* @__PURE__ */ new Set(["spec2rtl", "verification", "debug"]);
+    const allowed = /* @__PURE__ */ new Set(["spec2rtl", "spec2plan", "verification", "debug"]);
     const invalid = options.type.find((type) => !allowed.has(type));
     if (invalid) {
       throw new InvalidArgumentError(`Invalid knowledge type: ${invalid}`);
@@ -1065,7 +1074,7 @@ function printKnowledgeResult(result) {
   }
 }
 function addSearchOptions(command) {
-  return command.argument("<query>", "Natural-language RTL engineering question or diagnostic").option("--type <type...>", "Knowledge types: spec2rtl, 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, 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");
 }
 function registerKnowledgeCommands(program2) {
   for (const tool of TOOL_COMMANDS) {
@@ -1423,9 +1432,10 @@ 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 four tools exposed by the GenRTL MCP server")}
+  ${brand.dim("# Search the same five 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"')}
 `

package/package.json

@@ -1,21 +1,21 @@
-{
+{
   "name": "@genrtl/grtl",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "CLI, MCP, and coding-agent Skills for GenRTL RTL engineering knowledge",
   "type": "module",
   "bin": {
     "grtl": "dist/index.js"
   },
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint src --fix",
-    "lint:check": "eslint src",
-    "format": "prettier --write src",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --fix",
+    "lint:check": "eslint src",
+    "format": "prettier --write src",
     "format:check": "prettier --check src",
     "clean": "rm -rf dist node_modules",
     "test": "vitest run",
@@ -29,24 +29,24 @@
     "figlet": "^1.9.4",
     "ora": "^9.0.0",
     "picocolors": "^1.1.1"
-  },
-  "devDependencies": {
-    "@types/figlet": "^1.7.0",
-    "@types/node": "^22.19.1",
-    "@typescript-eslint/eslint-plugin": "^8.28.0",
-    "@typescript-eslint/parser": "^8.28.0",
-    "eslint": "^9.34.0",
-    "eslint-plugin-prettier": "^5.2.5",
-    "prettier": "^3.6.2",
-    "tsup": "^8.5.0",
-    "typescript": "^5.8.2",
-    "typescript-eslint": "^8.28.0",
-    "vitest": "^4.0.13"
-  },
-  "keywords": [
-    "genrtl",
-    "cli",
-    "ai",
+  },
+  "devDependencies": {
+    "@types/figlet": "^1.7.0",
+    "@types/node": "^22.19.1",
+    "@typescript-eslint/eslint-plugin": "^8.28.0",
+    "@typescript-eslint/parser": "^8.28.0",
+    "eslint": "^9.34.0",
+    "eslint-plugin-prettier": "^5.2.5",
+    "prettier": "^3.6.2",
+    "tsup": "^8.5.0",
+    "typescript": "^5.8.2",
+    "typescript-eslint": "^8.28.0",
+    "vitest": "^4.0.13"
+  },
+  "keywords": [
+    "genrtl",
+    "cli",
+    "ai",
     "rtl",
     "systemverilog",
     "verilog",
@@ -54,9 +54,9 @@
     "mcp"
   ],
   "author": "xroting",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
     "url": "git+https://github.com/xroting/grtl.git",
     "directory": "packages/cli"
   },