@genrtl/grtl 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +12 -3
  2. package/dist/index.js +16 -6
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -32,9 +32,18 @@ grtl setup --mcp --codex
32
32
  grtl setup --mcp --cursor --project
33
33
  ```
34
34
 
35
- Without `--cli` or `--mcp`, setup asks which mode to install.
36
-
37
- For Codex, Skills are installed under `.agents/skills` for project setup or
35
+ Without `--cli` or `--mcp`, setup asks which mode to install.
36
+
37
+ Installing a newer npm package does not modify Skills already written to an
38
+ agent configuration directory. Run the matching setup command again after an
39
+ upgrade to refresh the Skill. For example:
40
+
41
+ ```bash
42
+ grtl setup --cli --cursor
43
+ grtl setup --cli --cursor --project
44
+ ```
45
+
46
+ For Codex, Skills are installed under `.agents/skills` for project setup or
38
47
  `~/.agents/skills` for global setup. MCP mode also updates
39
48
  `.codex/config.toml` or `~/.codex/config.toml`.
40
49
 
package/dist/index.js CHANGED
@@ -381,15 +381,19 @@ Choose one tool:
381
381
  - \`genrtl_debug_search\` for lint, CDC, compile, synthesis, and RTL bugs
382
382
 
383
383
  Pass the complete engineering question in \`query\`. Add filters only when useful.`;
384
- var FALLBACK_CLI = `Use the \`grtl\` CLI for grounded RTL engineering knowledge.
384
+ var FALLBACK_CLI = `Use the \`grtl\` CLI for grounded RTL engineering knowledge and reusable CBB installation.
385
385
 
386
- Choose one command:
386
+ For knowledge retrieval, choose one command:
387
387
  - \`npx @genrtl/grtl@latest knowledge-search "<query>"\`
388
388
  - \`npx @genrtl/grtl@latest spec2rtl-search "<query>"\`
389
389
  - \`npx @genrtl/grtl@latest spec2plan-search "<query>"\`
390
390
  - \`npx @genrtl/grtl@latest verification-search "<query>"\`
391
391
  - \`npx @genrtl/grtl@latest debug-search "<query>"\`
392
392
 
393
+ To install a reusable RTL block into the current project:
394
+ - \`npx @genrtl/grtl@latest cbb install <cbb_id>@<version>\`
395
+ - Add \`--target <relative-dir>\` only when a non-default install path is needed.
396
+
393
397
  Pass the complete engineering question. Add filters such as \`--tool\`,
394
398
  \`--tool-version\`, \`--target\`, \`--interface\`, or \`--tag\` when known.
395
399
  If authentication fails, set \`GRTL_API_KEY\` or \`GENRTL_API_KEY\` in the
@@ -422,15 +426,15 @@ Pass the complete engineering question in \`query\`. Add \`filters\`, \`top_k\`,
422
426
  `;
423
427
  var CLI_SKILL = `---
424
428
  name: genrtl-cli
425
- description: Use the grtl CLI for grounded RTL design, verification, lint, CDC, synthesis, compile, and debugging knowledge.
429
+ description: Use the grtl CLI for grounded RTL design, verification, debugging knowledge, and secure installation of reusable RTL CBBs.
426
430
  ---
427
431
 
428
432
  # GenRTL CLI
429
433
 
430
- Use this skill when an RTL engineering task needs grounded GenRTL knowledge and
431
- the GenRTL MCP server is not configured.
434
+ Use this skill when an RTL engineering task needs grounded GenRTL knowledge or
435
+ a reusable CBB must be installed into the user's local project.
432
436
 
433
- Choose exactly one command:
437
+ For knowledge retrieval, choose exactly one command:
434
438
 
435
439
  - \`grtl knowledge-search "<query>" --json\` for cross-domain RTL questions.
436
440
  - \`grtl spec2rtl-search "<query>" --json\` for requirements, protocols, control logic, or algorithm-to-RTL work.
@@ -438,6 +442,12 @@ Choose exactly one command:
438
442
  - \`grtl verification-search "<query>" --json\` for testbenches and verification.
439
443
  - \`grtl debug-search "<query>" --json\` for lint, CDC, compile, synthesis, or RTL bugs.
440
444
 
445
+ For a CBB selected from GenRTL search results:
446
+
447
+ - \`grtl cbb install <cbb_id>@<version>\` downloads, verifies, and safely extracts it.
448
+ - Add \`--target <relative-dir>\` only when the user requests a specific project path.
449
+ - Do not download or extract the artifact manually; the CLI verifies SHA-256 and prevents unsafe ZIP paths.
450
+
441
451
  Pass the complete engineering question. Add filters such as \`--tool\`,
442
452
  \`--tool-version\`, \`--target\`, \`--interface\`, or \`--tag\` only when useful.
443
453
  The CLI requires \`GRTL_API_KEY\` or \`GENRTL_API_KEY\` in its environment.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@genrtl/grtl",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "CLI, MCP, and coding-agent Skills for GenRTL RTL engineering knowledge",
5
5
  "type": "module",
6
6
  "bin": {