Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .claude-plugin/marketplace.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
"plugins": [
{
"name": "gateflow",
"description": "AI-powered hardware development platform \u2014 design, verify, synthesize, and deploy working RTL with natural language. 18 agents, 25 skills, 8 IP blocks.",
"version": "2.3.0",
"description": "AI-powered hardware development platform \u2014 design, verify, synthesize, release, and deploy working RTL with natural language. 20 agents, 27 skills, 8 IP blocks.",
"version": "2.5.0",
"author": {
"name": "codejunkie99",
"github": "https://github.com/codejunkie99"
Expand All @@ -19,4 +19,4 @@
"category": "development"
}
]
}
}
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ Skills activate automatically based on context:
| `/gf-scan` | Index project files |
| `/gf-map` | Map codebase architecture |
| `/gf-doctor` | Check environment and dependencies |
| `/gf-tui` | Open the local GateFlow terminal console |
| `/gf-release` | Validate plugin release readiness |

### Example Session

Expand Down Expand Up @@ -253,7 +255,7 @@ GateFlow watches your workflow and helps proactively:

## Components

### Skills (26)
### Skills (27)

| Skill | Description | Source |
|-------|-------------|--------|
Expand Down Expand Up @@ -282,8 +284,10 @@ GateFlow watches your workflow and helps proactively:
| `gf-fusesoc` | FuseSoC build system integration | [SKILL.md](plugins/gateflow/skills/gf-fusesoc/SKILL.md) |
| `gf-learn-ctx` | Contextual learning — micro-lessons in workflows | [SKILL.md](plugins/gateflow/skills/gf-learn-ctx/SKILL.md) |
| `gf-ip-detect` | **Auto-detect IP blocks** — scan, match, auto-fill gaps | [SKILL.md](plugins/gateflow/skills/gf-ip-detect/SKILL.md) |
| `gf-tui` | **Terminal console** — local OpenClaw-style GateFlow dashboard | [SKILL.md](plugins/gateflow/skills/gf-tui/SKILL.md) |
| `gf-release` | **Release readiness** — validate manifests, docs, index, mirrors | [SKILL.md](plugins/gateflow/skills/gf-release/SKILL.md) |

### Agents (18)
### Agents (20)

| Agent | Expertise | Source |
|-------|-----------|--------|
Expand All @@ -305,8 +309,10 @@ GateFlow watches your workflow and helps proactively:
| `vhdl-testbench` | **VHDL testbench** — GHDL-compatible verification | [vhdl-testbench.md](plugins/gateflow/agents/vhdl-testbench.md) |
| `pcb-designer` | **KiCad PCB** — AI-verified schematics and layouts | [pcb-designer.md](plugins/gateflow/agents/pcb-designer.md) |
| `sv-ip-scanner` | **IP scanner** — detect missing modules, auto-fill | [sv-ip-scanner.md](plugins/gateflow/agents/sv-ip-scanner.md) |
| `gf-auditor` | **Plugin auditor** — find package gaps and stale docs | [gf-auditor.md](plugins/gateflow/agents/gf-auditor.md) |
| `gf-pluginfixer` | **Plugin fixer** — repair audited plugin gaps | [gf-pluginfixer.md](plugins/gateflow/agents/gf-pluginfixer.md) |

### Commands (18)
### Commands (21)

| Command | Description | Source |
|---------|-------------|--------|
Expand All @@ -328,6 +334,9 @@ GateFlow watches your workflow and helps proactively:
| `/gf-pinmap` | Generate pin constraint file for board | [gf-pinmap.md](plugins/gateflow/commands/gf-pinmap.md) |
| `/gf-cocotb` | Generate Python testbench (Cocotb) | [gf-cocotb.md](plugins/gateflow/commands/gf-cocotb.md) |
| `/gf-fusesoc` | Generate FuseSoC .core file | [gf-fusesoc.md](plugins/gateflow/commands/gf-fusesoc.md) |
| `/gf-audit` | Audit plugin quality and optionally auto-fix issues | [gf-audit.md](plugins/gateflow/commands/gf-audit.md) |
| `/gf-tui` | Open the local GateFlow terminal console | [gf-tui.md](plugins/gateflow/commands/gf-tui.md) |
| `/gf-release` | Validate plugin release readiness | [gf-release.md](plugins/gateflow/commands/gf-release.md) |

### IP Library (8 verified blocks)

Expand Down Expand Up @@ -521,9 +530,9 @@ clock_freq: 100MHz
Gateflow-Plugin/
├── plugins/gateflow/ # Main plugin source
│ ├── .claude-plugin/ # Plugin manifest
│ ├── agents/ # 18 specialized AI agents
│ ├── commands/ # 18 slash commands
│ ├── skills/ # 26 auto-activating skills
│ ├── agents/ # 20 specialized AI agents
│ ├── commands/ # 21 slash commands
│ ├── skills/ # 27 auto-activating skills
│ ├── hooks/ # Automation hooks + session tracking
│ ├── boards/ # Curated FPGA board database (4 boards)
│ ├── ip/ # Verified IP block library (8 blocks)
Expand Down Expand Up @@ -581,6 +590,13 @@ For detailed release notes, see [`releases.md`](releases.md).

| Version | Date | What Changed |
|---------|------|-------------|
| **2.5.0** | 2026-05-21 | OpenClaw-style CLI/TUI, release readiness workflow, deterministic validators, synced marketplace/docs/index/mirrors |
| **2.4.0** | 2026-04-11 | Deep skill enrichment across verification, synthesis, orchestration, architecture, learning, IP, and planning |
| **2.3.0** | 2026-03-27 | Quality pass, expanded IP docs, new commands, and component reference fixes |
| **2.2.1** | 2026-03-26 | IP auto-detection, auto-fill, CDC scanning, and `sv-ip-scanner` |
| **2.2.0** | 2026-03-26 | Community guides, KiCad, Cocotb, FuseSoC, CI templates, and ecosystem integrations |
| **2.1.0** | 2026-03-26 | VHDL, pin mapping, place and route, FPGA flash, and protocol scaffolding |
| **2.0.0** | 2026-03-26 | Formal verification, synthesis, IP library, and board database |
| **1.6.0** | 2026-03-26 | Version sync across plugin.json and marketplace.json; BSL-1.1 license confirmed |
| **1.5.3** | 2026-02-18 | Replace prompt-based PostToolUse hook with deterministic Python script |
| **1.5.2** | 2026-02-15 | Fix Stop hook JSON validation: replace prompt hook with deterministic command hook (non-blocking reminder) |
Expand Down
1 change: 1 addition & 0 deletions agents/gf-auditor.md
1 change: 1 addition & 0 deletions agents/gf-pluginfixer.md
1 change: 1 addition & 0 deletions agents/pcb-designer.md
1 change: 1 addition & 0 deletions agents/sv-formal.md
1 change: 1 addition & 0 deletions agents/sv-ip-scanner.md
1 change: 1 addition & 0 deletions agents/sv-pinmap.md
1 change: 1 addition & 0 deletions agents/sv-synth.md
1 change: 1 addition & 0 deletions agents/vhdl-codegen.md
1 change: 1 addition & 0 deletions agents/vhdl-testbench.md
101 changes: 82 additions & 19 deletions docs/gateflow.index
Original file line number Diff line number Diff line change
Expand Up @@ -3,41 +3,104 @@
# Use: Agent retrieval, codebase navigation

primary|CLAUDE.md|SV patterns, always_ff/comb, FSM, CDC, lint fixes, Spear/Tumbush book index
primary|README.md|Installation, usage, features
primary|README.md|Installation, usage, features, component inventory
primary|plugins/gateflow/README.md|Plugin-local overview and quick start
primary|releases.md|Release notes and version history

commands|commands/gf-doctor.md|Env check
commands|commands/gf-fix.md|Fix lint
commands|commands/gf-gen.md|Generate scaffolds
commands|commands/gf-lint.md|Run lint
commands|commands/gf-map.md|Map codebase
commands|commands/gf-scan.md|Index project
commands|commands/gf-sim.md|Run sim
commands|commands/gf-audit.md|Audit plugin quality and optionally auto-fix issues
commands|commands/gf-boards.md|List supported FPGA boards and query pinouts
commands|commands/gf-cocotb.md|Generate Cocotb Python testbenches
commands|commands/gf-demo.md|Create a zero-config demo project
commands|commands/gf-detect.md|Scan for missing IP blocks, stubs, and CDC issues
commands|commands/gf-doctor.md|Check environment and hardware tool dependencies
commands|commands/gf-fix.md|Fix lint errors
commands|commands/gf-flash.md|Program FPGA boards with openFPGALoader
commands|commands/gf-formal.md|Run formal verification
commands|commands/gf-fusesoc.md|Generate FuseSoC core files
commands|commands/gf-gen.md|Generate RTL and testbench scaffolds
commands|commands/gf-ip.md|Manage verified IP blocks
commands|commands/gf-lint.md|Run Verilator lint
commands|commands/gf-map.md|Map codebase architecture
commands|commands/gf-pcb.md|Generate KiCad schematic and PCB drafts
commands|commands/gf-pinmap.md|Generate board constraint files
commands|commands/gf-pnr.md|Run place and route workflows
commands|commands/gf-release.md|Validate and prepare GateFlow releases
commands|commands/gf-scan.md|Index project files
commands|commands/gf-sim.md|Run simulation
commands|commands/gf-tui.md|Open the local GateFlow terminal console

skills|skills/gf/SKILL.md|Main orchestrator, verification loops
skills|skills/gf-plan/SKILL.md|Hardware planner, Mermaid diagrams, FSM design
skills|skills/gf-architect/SKILL.md|Codebase mapping, hierarchy analysis
skills|skills/gf-build/SKILL.md|Parallel multi-component build orchestrator
skills|skills/gf-expand/SKILL.md|Design expansion and requirement elaboration
skills|skills/gf-learn/SKILL.md|Learning-oriented SV guidance and explanations
skills|skills/gf-cocotb/SKILL.md|Cocotb testbench generation and execution
skills|skills/gf-errors/SKILL.md|Three-layer hardware tool error translation
skills|skills/gf-expand/SKILL.md|Requirement expansion and clarifying questions
skills|skills/gf-formal/SKILL.md|Formal verification, SVA, SymbiYosys
skills|skills/gf-fusesoc/SKILL.md|FuseSoC and Edalize integration
skills|skills/gf-ip/SKILL.md|Verified IP block library operations
skills|skills/gf-ip-detect/SKILL.md|Missing IP, stub, pattern, and CDC detection
skills|skills/gf-learn/SKILL.md|Interactive SV learning mode
skills|skills/gf-learn-ctx/SKILL.md|Contextual micro-lessons and concept tracking
skills|skills/gf-lint/SKILL.md|Lint analysis and remediation workflow
skills|skills/gf-pcb/SKILL.md|KiCad schematic and PCB workflow
skills|skills/gf-pinmap/SKILL.md|Board-aware pin mapping
skills|skills/gf-plan/SKILL.md|Hardware planner, Mermaid diagrams, FSM design
skills|skills/gf-pnr/SKILL.md|Synthesis, place and route flow
skills|skills/gf-project/SKILL.md|Project context and .gateflow/project.yaml management
skills|skills/gf-protocols/SKILL.md|Protocol references and scaffolds
skills|skills/gf-release/SKILL.md|Release readiness validation and version prep
skills|skills/gf-router/SKILL.md|Task routing and intent classification
skills|skills/gf-sim/SKILL.md|Simulation flow and debug loops
skills|skills/gf-summary/SKILL.md|Summarization and progress reporting
skills|skills/gf-synth/SKILL.md|Yosys synthesis and resource reports
skills|skills/gf-tui/SKILL.md|OpenClaw-style local terminal console
skills|skills/gf-viz/SKILL.md|Terminal visualization, hierarchy and FSM diagrams
skills|skills/tb-best-practices/SKILL.md|Testbench best practices, layered TB, randomization, coverage, OOP patterns
skills|skills/tb-best-practices/SKILL.md|Testbench best practices, coverage, OOP patterns

agents|agents/gf-auditor.md|Plugin quality audit
agents|agents/gf-pluginfixer.md|Automatic plugin gap fixing
agents|agents/pcb-designer.md|KiCad schematic and PCB design
agents|agents/sv-codegen.md|RTL generation, modules, FSMs, FIFOs
agents|agents/sv-testbench.md|Testbench creation, stimulus, self-checking
agents|agents/sv-debug.md|Simulation failures, X-values, timing
agents|agents/sv-verification.md|SVA assertions, coverage, formal
agents|agents/sv-understanding.md|Code explanation, signal tracing
agents|agents/sv-developer.md|Multi-file development and complex features
agents|agents/sv-formal.md|Formal proofs and SVA properties
agents|agents/sv-ip-scanner.md|Missing IP, stubs, and CDC scanning
agents|agents/sv-orchestrator.md|Parallel component orchestration
agents|agents/sv-pinmap.md|Pin assignments and constraints
agents|agents/sv-planner.md|Architecture planning, design plans, diagrams
agents|agents/sv-orchestrator.md|Parallel component orchestration, multi-module builds
agents|agents/sv-refactor.md|Lint fixes, cleanup, optimization
agents|agents/sv-developer.md|Multi-file development, complex features
agents|agents/sv-synth.md|Yosys synthesis optimization
agents|agents/sv-testbench.md|Testbench creation, stimulus, self-checking
agents|agents/sv-tutor.md|SV tutoring and concept explanations
agents|agents/sv-viz.md|Terminal visualization, hierarchy diagrams, FSM rendering
agents|agents/sv-understanding.md|Code explanation and signal tracing
agents|agents/sv-verification.md|SVA assertions, coverage, formal
agents|agents/sv-viz.md|Terminal visualization and diagrams
agents|agents/vhdl-codegen.md|VHDL-2008 generation
agents|agents/vhdl-testbench.md|VHDL testbenches

hooks|hooks/hooks.json|Automation hooks configuration
hooks|hooks/scripts/check-dependencies.sh|Session dependency check
hooks|hooks/scripts/session-tracker.py|Session tracking
hooks|hooks/scripts/userpromptsubmit-sv-nudge.py|SystemVerilog prompt nudges
hooks|hooks/scripts/pretooluse-bash-guard.py|Bash safety guard
hooks|hooks/scripts/posttooluse-sv-lint-nudge.py|Post-edit lint reminder
hooks|hooks/scripts/stop-hook.sh|Session-end verification reminder

ip|ip/axi4lite_slave/block.yaml|AXI4-Lite register slave metadata
ip|ip/cdc_2ff/block.yaml|Two-flop synchronizer metadata
ip|ip/cdc_handshake/block.yaml|Multi-bit CDC handshake metadata
ip|ip/debouncer/block.yaml|Button debouncer metadata
ip|ip/fifo_async/block.yaml|Asynchronous FIFO metadata
ip|ip/fifo_sync/block.yaml|Synchronous FIFO metadata
ip|ip/spi_master/block.yaml|SPI master metadata
ip|ip/uart/block.yaml|UART TX/RX metadata

boards|boards/arty-a7-35t/board.yaml|Digilent Arty A7-35T board definition
boards|boards/basys3/board.yaml|Digilent Basys 3 board definition
boards|boards/icebreaker/board.yaml|1BitSquared iCEBreaker board definition
boards|boards/tang-nano-9k/board.yaml|Sipeed Tang Nano 9K board definition

tools|tools/validate_gateflow.py|Release metadata and package wiring validator
tools|tools/gateflow_tui.py|Local terminal console for GateFlow status and actions

reference|CLAUDE.md#external-references|Spear/Tumbush SV Verification 3rd ed (ch 1-12)
reference|CLAUDE.md#external-references|Spear/Tumbush SV Verification 3rd ed and SV for Design references
6 changes: 3 additions & 3 deletions plugins/gateflow/.claude-plugin/plugin.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "gateflow",
"version": "2.4.0",
"description": "AI-powered hardware development platform \u2014 design, verify, synthesize, and deploy working RTL with natural language. 20 agents, 25 skills, 8 IP blocks.",
"version": "2.5.0",
"description": "AI-powered hardware development platform \u2014 design, verify, synthesize, release, and deploy working RTL with natural language. 20 agents, 27 skills, 8 IP blocks.",
"author": {
"name": "codejunkie99",
"github": "https://github.com/codejunkie99",
Expand All @@ -22,4 +22,4 @@
],
"license": "BSL-1.1",
"repository": "https://github.com/codejunkie99/Gateflow-Plugin"
}
}
16 changes: 13 additions & 3 deletions plugins/gateflow/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# GateFlow

**The open-source AI hardware platform.** Design, verify, synthesize, and deploy working RTL from natural language. 20 agents. 25 skills. 8 verified IP blocks. One command.
**The open-source AI hardware platform.** Design, verify, synthesize, release, and deploy working RTL from natural language. 20 agents. 27 skills. 21 commands. 8 verified IP blocks.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Medium gateflow/README.md:3

The header claims 27 skills (line 3) and 27 Skills (line 69), but the table only lists 25 comma-separated skill items (4+3+4+3+4+2+1+1+1+2=25). The count overstates by 2. Consider updating the header and section title to 25 skills / 25 Skills to match the actual table contents.

Suggested change
**The open-source AI hardware platform.** Design, verify, synthesize, release, and deploy working RTL from natural language. 20 agents. 27 skills. 21 commands. 8 verified IP blocks.
**The open-source AI hardware platform.** Design, verify, synthesize, release, and deploy working RTL from natural language. 20 agents. 25 skills. 21 commands. 8 verified IP blocks.
🚀 Reply "fix it for me" or copy this AI Prompt for your agent:
In file plugins/gateflow/README.md around line 3:

The header claims **27 skills** (line 3) and **27 Skills** (line 69), but the table only lists 25 comma-separated skill items (4+3+4+3+4+2+1+1+1+2=25). The count overstates by 2. Consider updating the header and section title to **25 skills** / **25 Skills** to match the actual table contents.


```bash
claude plugin add codejunkie99/Gateflow-Plugin
Expand Down Expand Up @@ -66,7 +66,7 @@ claude plugin add codejunkie99/Gateflow-Plugin
| `gf-auditor` | Plugin health checks |
| `gf-pluginfixer` | Auto-fix plugin issues |

### 25 Skills
### 27 Skills

| Category | Skills |
|----------|--------|
Expand All @@ -77,9 +77,11 @@ claude plugin add codejunkie99/Gateflow-Plugin
| **Hardware** | `/gf-pcb`, `/gf-pnr`, `/gf-pinmap`, `/gf-fusesoc` |
| **Learning** | `/gf-learn`, `/gf-learn-ctx` |
| **Visualization** | `/gf-viz` |
| **Terminal** | `/gf-tui` |
| **Release** | `/gf-release` |
| **Reference** | `tb-best-practices`, `/gf-build` |

### 19 Commands
### 21 Commands

| Command | Description |
|---------|-------------|
Expand All @@ -102,6 +104,8 @@ claude plugin add codejunkie99/Gateflow-Plugin
| `/gf-fusesoc` | FuseSoC .core files |
| `/gf-demo` | Interactive demo |
| `/gf-audit` | Plugin health audit |
| `/gf-tui` | Local terminal console |
| `/gf-release` | Release readiness validation |

### 8 Verified IP Blocks

Expand Down Expand Up @@ -195,6 +199,12 @@ claude plugin add codejunkie99/Gateflow-Plugin

# Target real hardware
/gf-pnr synthesize and place for iCEBreaker

# Prepare plugin release
/gf-release --check-only

# Open terminal console
/gf-tui
```

---
Expand Down
47 changes: 47 additions & 0 deletions plugins/gateflow/commands/gf-release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: gf-release
description: Validate GateFlow plugin readiness and prepare a versioned release
argument-hint: "[--version X.Y.Z] [--check-only]"
allowed-tools:
- Bash
- Read
- Edit
- Write
- Glob
- Grep
---

# GateFlow Release Command

Prepare and validate a GateFlow plugin release.

## Usage

```
/gf-release --check-only
/gf-release --version 2.5.0
```

## Workflow

1. Invoke the `gf-release` skill.
2. Run the deterministic validator:

```bash
python3 tools/validate_gateflow.py --version <version>
```

3. If validation fails, fix the reported package wiring issues before tagging.
4. Confirm `plugins/gateflow/.claude-plugin/plugin.json`, `.claude-plugin/marketplace.json`,
`README.md`, `plugins/gateflow/README.md`, `docs/gateflow.index`, and `releases.md`
all describe the same version and component counts.
5. For a real release, create a git tag and GitHub release only after validation passes.

## Output

Report:
- version being prepared
- component inventory
- validation failures, if any
- files that must change before release
- final tag command when ready
Loading
Loading