rat-plugin-debug

Files (1)

• SKILL.md

SKILL.md (first lines)

<Purpose>
Display RTL Agent Team plugin diagnostics for debugging and environment verification.
Shows plugin version, EDA tool availability, state file status, and hook health.
</Purpose>

<Use_When>
- Debugging plugin issues or unexpected behavior
- Verifying EDA tool installation status
- Checking plugin state files for stale or corrupt entries
- User says "debug", "diagnostics", "plugin status", "rat debug"
</Use_When>

<Do_Not_Use_When>
- Setting up a new project (use rat-init-project) or installing tools (use rat-setup)
- Running design pipeline (use rat-auto-design or phase-specific skills)
</Do_Not_Use_When>

## Execution

Run each diagnostic section and present a consolidated report. All checks are read-only and non-destructive.

### 1. Plugin Version

```bash
# Read plugin version from manifest
grep -m 1 '"version"' "${CLAUDE_PLUGIN_ROOT}/.claude-plugin/plugin.json" 2>/dev/null
# Fallback: check if CLAUDE_PLUGIN_ROOT is set
echo "CLAUDE_PLUGIN_ROOT=${CLAUDE_PLUGIN_ROOT:-NOT_SET}"
```

Report: `rtl-agent-team v{version}` and plugin root path.

### 2. EDA Tool Status

Check each tool and report version or NOT_FOUND. Group by classification:

```bash
first_line_or_not_found() {
  local tool="$1"
  local output
  local rc
  shift
  if ! command -v "$tool" >/dev/null 2>&1; then
    echo "NOT_FOUND"
    return 127
  fi
  if output="$("$@" 2>&1)"; then
    printf '%s\n' "$output" | sed -n '1p'
  else
    rc=$?
    printf '%s\n' "$output" | sed -n '1p' >&2
    return "$rc"
  fi
}

# --- Required ---
first_line_or_not_found verilator verilator --version
first_line_or_not_found python3 python3 --version
python3 -c "import cocotb; print('cocotb', cocotb.__version__)" 2>&1 || echo "NOT_FOUND"
first_line_or_not_found g++ g++ --version
first_line_or_not_found make make --version
pkg-config --modversion systemc 2>/dev/null || (test -n "$SYSTEMC_HOME" && test -d "$SYSTEMC_HOME" && echo "systemc via SYSTEMC_HOME=$SYSTEMC_HOME") || echo "NOT_FOUND"

# --- Lint tools (at least one required) ---
first_line_or_not_found verible-verilog-lint verible-verilog-lint --version
first_line_or_not_found slang slang --version

# --- CDC tools (at least one required) ---
first_line_or_not_found svlens svlens --version
for tool in sg_shell vc_cdc questa_cdc; do
  command -v "$tool" 2>/dev/null || echo "NOT_FOUND"
done

# --- Recommended ---
first_line_or_not_found slang-server slang-server --version
jq --version 2>&1 || echo "NOT_FOUND"

# --- Optional ---
first_line_or_not_found iverilog iverilog -V
first_line_or_not_found yosys yosys --version
first_line_or_not_found sby sby --help
first_line_or_not_found gtkwave gtkwave --version
first_line_or_not_found docker docker --version
```

Report as a table with status icons: `[OK]` installed, `[!!]` required but missing, `[--]` optional and missing.

### 3. Project Setup Status

```bash
# Check if rat-init-project has been run (marker: .claude/rules/rtl-coding-conventions.md)
test -f .claude/rules/rtl-coding-conventions.md && echo "SETUP_DONE" || echo "SETUP_NOT_DONE"

# Check directory structure
for dir in specs refc rtl sim lint syn docs reviews .rat/state; do
  test -d "$dir" && echo "[OK] $dir" || echo "[--] $dir"
done

# Check deployed rules
for f in .claude/rules/rtl-coding-conventions.md .claude/rules/rtl-verification-gate.md; do
  test -f "$f" && echo "[OK] $f" || echo "[--] $f"
done
# Diagram rules: check global CLAUDE.md tag OR local fallback file
grep -q '<markdown_diagram_rule>' ~/.claude/CLAUDE.md 2>/dev/null && echo "[OK] diagram-rules (global CLAUDE.md tag)" || \
  (test -f .claude/rules/diagram-rules.md && echo "[OK] diagram-rules (local file)" || echo "[--] diagram-rules (neither global tag nor local file)")

# Check deployed guides
for f in rtl/CLAUDE.md sim/CLAUDE.md docs/CLAUDE.md reviews/CLAUDE.md refc/CLAUDE.md syn/CLAUDE.md; do
  test -f "$f" && echo "[OK] $f" || echo "[--] $f"
done
```

### 4. State Files

```bash
# List all state files with age
find .rat/state/ -name "*.json" -type f 2>/dev/null | while read f; do
  AGE_SEC=$(( $(date +%s) - $(stat -c %Y "$f" 2>/dev/null || stat -f %m "$f" 2>/dev/null || echo 0) ))
  AGE_MIN=$(( AGE_SEC / 60 ))

From babyworm/rtl-agent-team, MIT.

More from babyworm/rtl-agent-team