Skip to content
Back to search

Gateflow-Plugin

AI-powered SystemVerilog development assistant — design, verify, debug, and deliver working RTL with natural language.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/codejunkie99--gateflow-plugin/badge.svg)](/listings/codejunkie99--gateflow-plugin)

HTML

<a href="/listings/codejunkie99--gateflow-plugin"><img src="/api/listings/codejunkie99--gateflow-plugin/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

Install

# Option 1: Marketplace (recommended)
claude plugin marketplace add codejunkie99/Gateflow-Plugin
claude plugin install gateflow

# Option 2: Clone and run
git clone https://github.com/codejunkie99/Gateflow-Plugin.git
claude --plugin-dir ./Gateflow-Plugin/plugins/gateflow

# Option 3: Persistent (add to ~/.claude/settings.json)
git clone https://github.com/codejunkie99/Gateflow-Plugin.git ~/.claude-plugins/gateflow-marketplace

For Option 3, add to `~/.claude/settings.json` or `.claude/settings.json`:

{
  "plugins": [
    "~/.claude-plugins/gateflow-marketplace/plugins/gateflow"
  ]
}

Prerequisites

| Tool | Required | macOS | Linux | |------|----------|-------|-------| | [Claude Code](https://code.claude.com/) | Yes | See website | See website | | [Verilator](https://verilator.org/) | Recommended | `brew install verilator` | `sudo apt install verilator` | | Verible | Optional | `brew tap chipsalliance/verible && brew install verible` | See [releases](https://github.com/chipsalliance/verible/releases) | | [Yosys](https://github.com/YosysHQ/yosys) | For synthesis | `brew install yosys` | `sudo apt install yosys` | | [SymbiYosys](https://github.com/YosysHQ/sby) | For formal | `pip install symbiyosys` | `pip install symbiyosys` | | [GHDL](https://github.com/ghdl/ghdl) | For VHDL | `brew install ghdl` | `sudo apt install ghdl` | | [nextpnr](https://github.com/YosysHQ/nextpnr) | For P&R | `brew install nextpnr` | See GitHub | | [openFPGALoader](https://github.com/trabucayre/openFPGALoader) | For flash | `brew install openfpgaloader` | See GitHub |

Verify & Update

# Verify installation
/gf-doctor

# Update (marketplace)
# /plugin → Marketplaces → gateflow → Update → restart Claude Code

# Update (local)
# git pull in your plugin folder, then restart Claude Code

---

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

.claude-plugin/marketplace.json · Manifest · 22 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. {
  2. "$schema": "https://anthropic.com/claude-code/marketplace.schema.json",
  3. "name": "gateflow",
  4. "description": "AI-powered SystemVerilog development assistant \u2014 design, verify, debug, and deliver working RTL with natural language.",
  5. "owner": {
  6. "name": "codejunkie99",
  7. "github": "https://github.com/codejunkie99"
  8. },
  9. "plugins": [
  10. {
  11. "name": "gateflow",
  12. "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.",
  13. "version": "2.5.3",
  14. "author": {
  15. "name": "codejunkie99",
  16. "github": "https://github.com/codejunkie99"
  17. },
  18. "source": "./plugins/gateflow",
  19. "category": "development"
  20. }
  21. ]
  22. }
README.md · README · 667 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # GateFlow Plugin for Claude Code
  2. > AI-powered hardware development platform — design, verify, synthesize, and deploy working RTL with natural language. Supports SystemVerilog, Verilog, and VHDL across the full open-source FPGA toolchain.
  3. [![GitHub Stars](https://img.shields.io/github/stars/codejunkie99/Gateflow-Plugin?style=social)](https://github.com/codejunkie99/Gateflow-Plugin/stargazers)
  4. [![Version](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fcodejunkie99%2FGateflow-Plugin%2Fmain%2Fplugins%2Fgateflow%2F.claude-plugin%2Fplugin.json&query=%24.version&label=version&color=blue)](https://github.com/codejunkie99/Gateflow-Plugin/releases)
  5. [![License: BSL-1.1](https://img.shields.io/badge/License-BSL%201.1-orange.svg)](LICENSE)
  6. [![Claude Code Plugin](https://img.shields.io/badge/Claude%20Code-Plugin-purple.svg)](https://code.claude.com/)
  7. ![GateFlow Demo](https://github.com/user-attachments/assets/73115231-5dac-473c-8f6b-5ed88a780135)
  8. ![GateFlow v2.3.1 Update](plugins/gateflow/assets/update-2.3.1.svg)
  9. ---
  10. **Loving hardware doesn't have to be gatekept.**
  11. GateFlow brings professional hardware development tooling to Claude Code. Describe what you want to build — including your target board — and get lint-checked, simulated, formally verified, synthesis-ready code with correct pin assignments.
  12. Whether you're writing your first `always_ff`, formally proving your FIFO never overflows, or synthesizing an SPI controller for your Arty A7, the tools should help you, not fight you.
  13. We can't wait to see what you create. ❤️
  14. ---
  15. - [Quick Start](#quick-start) — Install in one command
  16. - [Usage](#usage) — Natural language, skills, and commands
  17. - [Features](#features) — What makes GateFlow different
  18. - [Components](#components) — All skills, agents, and commands
  19. - [Individual Downloads](#individual-downloads) — Grab single components
  20. - [Cross-Tool Compatibility](#cross-tool-compatibility) — Use with Codex, Cursor, Copilot, Cline, Windsurf
  21. - [Configuration](#configuration) — Project-specific settings
  22. - [Project Structure](#project-structure) — Repo layout
  23. - [Troubleshooting](#troubleshooting) — Common issues
  24. - [Updates](#updates) — Changelog
  25. - [Releases](releases.md) — Detailed release notes
  26. - [Contributing](#contributing) | [License](#license) | [Links](#links)
  27. ---
  28. ## Quick Start
  29. ### Install
  30. ```bash
  31. # Option 1: Marketplace (recommended)
  32. claude plugin marketplace add codejunkie99/Gateflow-Plugin
  33. claude plugin install gateflow
  34. # Option 2: Clone and run
  35. git clone https://github.com/codejunkie99/Gateflow-Plugin.git
  36. claude --plugin-dir ./Gateflow-Plugin/plugins/gateflow
  37. # Option 3: Persistent (add to ~/.claude/settings.json)
  38. git clone https://github.com/codejunkie99/Gateflow-Plugin.git ~/.claude-plugins/gateflow-marketplace
  39. ```
  40. For Option 3, add to `~/.claude/settings.json` or `.claude/settings.json`:
  41. ```json
  42. {
  43. "plugins": [
  44. "~/.claude-plugins/gateflow-marketplace/plugins/gateflow"
  45. ]
  46. }
  47. ```
  48. ### Prerequisites
  49. | Tool | Required | macOS | Linux |
  50. |------|----------|-------|-------|
  51. | [Claude Code](https://code.claude.com/) | Yes | See website | See website |
  52. | [Verilator](https://verilator.org/) | Recommended | `brew install verilator` | `sudo apt install verilator` |
  53. | Verible | Optional | `brew tap chipsalliance/verible && brew install verible` | See [releases](https://github.com/chipsalliance/verible/releases) |
  54. | [Yosys](https://github.com/YosysHQ/yosys) | For synthesis | `brew install yosys` | `sudo apt install yosys` |
  55. | [SymbiYosys](https://github.com/YosysHQ/sby) | For formal | `pip install symbiyosys` | `pip install symbiyosys` |
  56. | [GHDL](https://github.com/ghdl/ghdl) | For VHDL | `brew install ghdl` | `sudo apt install ghdl` |
  57. | [nextpnr](https://github.com/YosysHQ/nextpnr) | For P&R | `brew install nextpnr` | See GitHub |
  58. | [openFPGALoader](https://github.com/trabucayre/openFPGALoader) | For flash | `brew install openfpgaloader` | See GitHub |
  59. ### Verify & Update
  60. ```bash
  61. # Verify installation
  62. /gf-doctor
  63. # Update (marketplace)
  64. # /plugin → Marketplaces → gateflow → Update → restart Claude Code
  65. # Update (local)
  66. # git pull in your plugin folder, then restart Claude Code
  67. ```
  68. ---
  69. ## Usage
  70. ### Just Ask
  71. GateFlow understands context. Describe what you need in plain English:
  72. ```
  73. "Create a FIFO and test it"
  74. → Generates FIFO, creates testbench, runs simulation, fixes issues, delivers working code
  75. "Formally verify that the FIFO never overflows"
  76. → Generates SVA properties, configures SymbiYosys, runs proof, reports results
  77. "Synthesize my design for the iCEBreaker board"
  78. → Runs Yosys synthesis, reports LUT/FF/BRAM usage, generates constraint file
  79. "Add an SPI controller to my project"
  80. → Installs verified SPI master IP block with testbench and formal proofs
  81. "What pins does the Arty A7 PMOD JA have?"
  82. → Looks up curated board database, shows pin assignments with I/O standards
  83. "Why is my output X?"
  84. → Analyzes code, traces signal path, identifies root cause
  85. "Plan a DMA controller"
  86. → Creates detailed design plan with block diagrams, FSMs, interfaces, verification strategy
  87. ```
  88. ### Skills (Auto-Activating)
  89. Skills activate automatically based on context:
  90. | Skill | Trigger | What It Does |
  91. |-------|---------|--------------|
  92. | `/gf` | Any SV task | **Main orchestrator** — plan-first, parallel build, verify until working |
  93. | `/gf-plan` | "plan", "design", "architect" | RTL implementation plans with ASCII diagrams |
  94. | `/gf-build` | "build", "multi-component", "SoC" | Parallel component build orchestration |
  95. | `/gf-formal` | "formally verify", "prove", "check property" | **Formal verification from natural language** via SymbiYosys |
  96. | `/gf-synth` | "synthesize", "area estimate", "resource usage" | **Yosys synthesis** with LUT/FF/BRAM/DSP reports |
  97. | `/gf-architect` | "map codebase", "analyze project" | Codebase map with hierarchy, FSMs, clocks, CDC |
  98. | `/gf-viz` | "visualize", "show hierarchy" | Terminal ASCII visualization of RTL architecture |
  99. | `/gf-learn` | "teach me", "exercise", "practice" | Learning mode with exercises and feedback |
  100. ### Commands
  101. | Command | What It Does |
  102. |---------|-------------|
  103. | `/gf-lint` | Run Verilator lint with structured output |
  104. | `/gf-fix` | Auto-fix lint errors |
  105. | `/gf-sim` | Compile and run simulation |
  106. | `/gf-formal` | Run SymbiYosys formal verification |
  107. | `/gf-gen` | Generate module/testbench scaffolds |
  108. | `/gf-ip` | Manage verified IP block library (add/list/info) |
  109. | `/gf-boards` | List supported FPGA boards and query pinouts |
  110. | `/gf-demo` | One-command zero-config showcase project |
  111. | `/gf-scan` | Index project files |
  112. | `/gf-map` | Map codebase architecture |
  113. | `/gf-doctor` | Check environment and dependencies |
  114. | `/gf-tui` | Open the local GateFlow terminal console |
  115. | `/gf-release` | Validate plugin release readiness |
  116. ### Local CLI
  117. GateFlow also ships with a command-first local CLI for plugin maintenance and
  118. agent creation:
  119. ```bash
  120. python3 tools/gateflow_cli.py status
  121. python3 tools/gateflow_cli.py agents list
  122. python3 tools/gateflow_cli.py agents create "CDC Reviewer" \
  123. --role "clock-domain crossing reviewer" \
  124. --description "Reviews synchronizers and CDC constraints"
  125. python3 tools/gateflow_cli.py shell
  126. python3 tools/gateflow_cli.py tui
  127. ```
  128. Inside the TUI, press `a` to create a new agent without leaving the dashboard.
  129. ### Example Session
  130. ```
  131. $ claude --plugin-dir ./Gateflow-Plugin/plugins/gateflow
  132. You: Create a parameterized counter with enable and test it
  133. Claude: Creating counter module...
  134. ✓ Created counter.sv
  135. Running lint check...
  136. ✓ Lint clean
  137. Creating testbench...
  138. ✓ Created tb_counter.sv
  139. Running simulation...
  140. ✓ All tests pass (12 checks)
  141. Done! Created:
  142. - rtl/counter.sv (8-bit parameterized counter with enable)
  143. - tb/tb_counter.sv (Self-checking testbench)
  144. ```
  145. ---
  146. ## Features
  147. ### Working Code, Not Just Generated Code
  148. The `/gf` orchestrator doesn't stop at generation — it verifies:
  149. ```
  150. Create → Lint → Fix → Test → Fix → Formally Verify → Synthesize → Deliver
  151. ```
  152. ### Formal Verification from Natural Language
  153. Tell GateFlow what to prove in plain English:
  154. ```
  155. "Formally verify that the FIFO never overflows and the pointers are always consistent"
  156. → Generates SVA assert property statements
  157. → Configures SymbiYosys (.sby file)
  158. → Runs bounded model checking
  159. → Reports proof results or explains counterexamples in English
  160. ```
  161. ### Yosys Synthesis with Resource Reports
  162. ```
  163. "Synthesize my design for the iCEBreaker"
  164. → Checks for unsupported SV constructs (warns before failing)
  165. → Runs Yosys synthesis targeting iCE40
  166. → Reports: LUTs: 142, FFs: 87, BRAM: 1, DSP: 0
  167. ```
  168. ### Drop-In IP Library
  169. 8 verified, formally proven IP blocks ready to use:
  170. ```
  171. /gf-ip add fifo_sync → Installs FIFO with RTL + testbench + formal proofs
  172. /gf-ip add uart → UART TX+RX with configurable baud rate
  173. /gf-ip add axi4lite_slave → AXI4-Lite register interface
  174. ```
  175. Every block is lint-clean, simulation-tested, and formally verified.
  176. ### Board-Aware Development
  177. GateFlow knows your FPGA board's pinout:
  178. ```
  179. /gf-boards arty-a7-35t pmod-ja → Shows exact pin assignments
  180. ```
  181. Curated constraint files (.xdc, .pcf, .cst) for popular boards included.
  182. ### Hardware Design Planning
  183. `/gf-plan` creates professional design documents:
  184. - Block diagrams (ASCII and Mermaid)
  185. - Module hierarchy and interface specs
  186. - FSM state diagrams
  187. - Clock domain analysis
  188. - Verification strategy and implementation phases
  189. ### Codebase Intelligence
  190. `/gf-architect` maps your entire project:
  191. - Module hierarchy and dependencies
  192. - Signal flow analysis and FSM extraction
  193. - Clock domain crossing detection
  194. - Package and type definitions
  195. ### Comprehensive Coverage
  196. - **Memory**: FIFOs, dual-port RAM, register files
  197. - **Error handling**: ECC, watchdogs, TMR
  198. - **DFT**: Scan chains, JTAG, BIST
  199. - **Timing**: Retiming, pipelining, SDC
  200. - **Verification**: SVA, coverage, formal
  201. ### Smart Hooks
  202. GateFlow watches your workflow and helps proactively:
  203. - **After SV edits** — reminds you to lint
  204. - **Before destructive commands** — warns if you're about to delete SV files
  205. - **On session end** — checks if you forgot to lint or simulate modified files
  206. - **Progressive tips** — surfaces slash commands you haven't used yet
  207. ---
  208. ## Components
  209. ### Skills (27)
  210. | Skill | Description | Source |
  211. |-------|-------------|--------|
  212. | `gf` | Main orchestrator — plan, build, verify until working | [SKILL.md](plugins/gateflow/skills/gf/SKILL.md) |
  213. | `gf-plan` | RTL implementation planning with diagrams | [SKILL.md](plugins/gateflow/skills/gf-plan/SKILL.md) |
  214. | `gf-build` | Parallel component build orchestration | [SKILL.md](plugins/gateflow/skills/gf-build/SKILL.md) |
  215. | `gf-formal` | **Formal verification from natural language** (SymbiYosys) | [SKILL.md](plugins/gateflow/skills/gf-formal/SKILL.md) |
  216. | `gf-synth` | **Yosys synthesis** with area/timing reports | [SKILL.md](plugins/gateflow/skills/gf-synth/SKILL.md) |
  217. | `gf-ip` | **IP block library** — verified drop-in components | [SKILL.md](plugins/gateflow/skills/gf-ip/SKILL.md) |
  218. | `gf-architect` | Codebase map with hierarchy, FSMs, clocks, CDC | [SKILL.md](plugins/gateflow/skills/gf-architect/SKILL.md) |
  219. | `gf-lint` | Structured Verilator lint checking | [SKILL.md](plugins/gateflow/skills/gf-lint/SKILL.md) |
  220. | `gf-sim` | Simulation with auto DUT/TB detection | [SKILL.md](plugins/gateflow/skills/gf-sim/SKILL.md) |
  221. | `gf-viz` | Terminal visualization of RTL architecture | [SKILL.md](plugins/gateflow/skills/gf-viz/SKILL.md) |
  222. | `gf-learn` | Learning mode — exercises, reviews, hints | [SKILL.md](plugins/gateflow/skills/gf-learn/SKILL.md) |
  223. | `gf-errors` | 3-layer error translation for hardware tools | [SKILL.md](plugins/gateflow/skills/gf-errors/SKILL.md) |
  224. | `gf-project` | Project context (.gateflow/project.yaml) management | [SKILL.md](plugins/gateflow/skills/gf-project/SKILL.md) |
  225. | `gf-router` | Intent classification and routing | [SKILL.md](plugins/gateflow/skills/gf-router/SKILL.md) |
  226. | `gf-expand` | Clarifying questions with trade-offs | [SKILL.md](plugins/gateflow/skills/gf-expand/SKILL.md) |
  227. | `gf-summary` | Summarize Verilator/lint output | [SKILL.md](plugins/gateflow/skills/gf-summary/SKILL.md) |
  228. | `tb-best-practices` | Testbench best practices reference | [SKILL.md](plugins/gateflow/skills/tb-best-practices/SKILL.md) |
  229. | `gf-pinmap` | **Board-aware pin mapping** with constraint generation | [SKILL.md](plugins/gateflow/skills/gf-pinmap/SKILL.md) |
  230. | `gf-pnr` | Place & route via nextpnr (iCE40/ECP5/Gowin) | [SKILL.md](plugins/gateflow/skills/gf-pnr/SKILL.md) |
  231. | `gf-protocols` | Protocol scaffolding (AXI4, SPI, I2C, Wishbone) | [SKILL.md](plugins/gateflow/skills/gf-protocols/SKILL.md) |
  232. | `gf-pcb` | **KiCad schematic/PCB** with AI verification loop | [SKILL.md](plugins/gateflow/skills/gf-pcb/SKILL.md) |
  233. | `gf-cocotb` | Python testbenches via Cocotb | [SKILL.md](plugins/gateflow/skills/gf-cocotb/SKILL.md) |
  234. | `gf-fusesoc` | FuseSoC build system integration | [SKILL.md](plugins/gateflow/skills/gf-fusesoc/SKILL.md) |
  235. | `gf-learn-ctx` | Contextual learning — micro-lessons in workflows | [SKILL.md](plugins/gateflow/skills/gf-learn-ctx/SKILL.md) |
  236. | `gf-ip-detect` | **Auto-detect IP blocks** — scan, match, auto-fill gaps | [SKILL.md](plugins/gateflow/skills/gf-ip-detect/SKILL.md) |
  237. | `gf-tui` | **Terminal console** — local OpenClaw-style GateFlow dashboard | [SKILL.md](plugins/gateflow/skills/gf-tui/SKILL.md) |
  238. | `gf-release` | **Release readiness** — validate manifests, docs, index, mirrors | [SKILL.md](plugins/gateflow/skills/gf-release/SKILL.md) |
  239. ### Agents (20)
  240. | Agent | Expertise | Source |
  241. |-------|-----------|--------|
  242. | `sv-codegen` | RTL architect — synthesizable modules | [sv-codegen.md](plugins/gateflow/agents/sv-codegen.md) |
  243. | `sv-testbench` | Verification engineer — testbenches and stimulus | [sv-testbench.md](plugins/gateflow/agents/sv-testbench.md) |
  244. | `sv-debug` | Debug specialist — simulation failures, X-values | [sv-debug.md](plugins/gateflow/agents/sv-debug.md) |
  245. | `sv-formal` | **Formal verification** — SVA properties, SymbiYosys proofs | [sv-formal.md](plugins/gateflow/agents/sv-formal.md) |
  246. | `sv-synth` | **Synthesis specialist** — Yosys, area/timing optimization | [sv-synth.md](plugins/gateflow/agents/sv-synth.md) |
  247. | `sv-verification` | Verification methodologist — SVA, coverage, formal | [sv-verification.md](plugins/gateflow/agents/sv-verification.md) |
  248. | `sv-understanding` | RTL analyst — explains and documents code | [sv-understanding.md](plugins/gateflow/agents/sv-understanding.md) |
  249. | `sv-planner` | Architecture planner — design plans and diagrams | [sv-planner.md](plugins/gateflow/agents/sv-planner.md) |
  250. | `sv-orchestrator` | Parallel builder — multi-component designs | [sv-orchestrator.md](plugins/gateflow/agents/sv-orchestrator.md) |
  251. | `sv-refactor` | Code quality — lint fixes, cleanup, optimization | [sv-refactor.md](plugins/gateflow/agents/sv-refactor.md) |
  252. | `sv-developer` | Full-stack RTL — complex multi-file features | [sv-developer.md](plugins/gateflow/agents/sv-developer.md) |
  253. | `sv-tutor` | Teacher — reviews solutions, gives hints | [sv-tutor.md](plugins/gateflow/agents/sv-tutor.md) |
  254. | `sv-viz` | Terminal visualization of RTL architecture | [sv-viz.md](plugins/gateflow/agents/sv-viz.md) |
  255. | `sv-pinmap` | **Pin assignment specialist** — constraint files | [sv-pinmap.md](plugins/gateflow/agents/sv-pinmap.md) |
  256. | `vhdl-codegen` | **VHDL code generation** — entities and architectures | [vhdl-codegen.md](plugins/gateflow/agents/vhdl-codegen.md) |
  257. | `vhdl-testbench` | **VHDL testbench** — GHDL-compatible verification | [vhdl-testbench.md](plugins/gateflow/agents/vhdl-testbench.md) |
  258. | `pcb-designer` | **KiCad PCB** — AI-verified schematics and layouts | [pcb-designer.md](plugins/gateflow/agents/pcb-designer.md) |
  259. | `sv-ip-scanner` | **IP scanner** — detect missing modules, auto-fill | [sv-ip-scanner.md](plugins/gateflow/agents/sv-ip-scanner.md) |
  260. | `gf-auditor` | **Plugin auditor** — find package gaps and stale docs | [gf-auditor.md](plugins/gateflow/agents/gf-auditor.md) |
  261. | `gf-pluginfixer` | **Plugin fixer** — repair audited plugin gaps | [gf-pluginfixer.md](plugins/gateflow/agents/gf-pluginfixer.md) |
  262. ### Commands (21)
  263. | Command | Description | Source |
  264. |---------|-------------|--------|
  265. | `/gf-doctor` | Environment check | [gf-doctor.md](plugins/gateflow/commands/gf-doctor.md) |
  266. | `/gf-demo` | Zero-config showcase project | [gf-demo.md](plugins/gateflow/commands/gf-demo.md) |
  267. | `/gf-formal` | Run formal verification | [gf-formal.md](plugins/gateflow/commands/gf-formal.md) |
  268. | `/gf-ip` | Manage IP block library | [gf-ip.md](plugins/gateflow/commands/gf-ip.md) |
  269. | `/gf-boards` | List boards and query pinouts | [gf-boards.md](plugins/gateflow/commands/gf-boards.md) |
  270. | `/gf-scan` | Index project | [gf-scan.md](plugins/gateflow/commands/gf-scan.md) |
  271. | `/gf-map` | Map codebase | [gf-map.md](plugins/gateflow/commands/gf-map.md) |
  272. | `/gf-lint` | Run lint | [gf-lint.md](plugins/gateflow/commands/gf-lint.md) |
  273. | `/gf-fix` | Fix lint | [gf-fix.md](plugins/gateflow/commands/gf-fix.md) |
  274. | `/gf-gen` | Generate scaffolds | [gf-gen.md](plugins/gateflow/commands/gf-gen.md) |
  275. | `/gf-sim` | Run simulation | [gf-sim.md](plugins/gateflow/commands/gf-sim.md) |
  276. | `/gf-pnr` | Place & route (nextpnr) | [gf-pnr.md](plugins/gateflow/commands/gf-pnr.md) |
  277. | `/gf-flash` | Flash FPGA board | [gf-flash.md](plugins/gateflow/commands/gf-flash.md) |
  278. | `/gf-detect` | Scan for missing IP blocks and CDC issues | [gf-detect.md](plugins/gateflow/commands/gf-detect.md) |
  279. | `/gf-pcb` | Generate KiCad schematic/PCB (AI-verified) | [gf-pcb.md](plugins/gateflow/commands/gf-pcb.md) |
  280. | `/gf-pinmap` | Generate pin constraint file for board | [gf-pinmap.md](plugins/gateflow/commands/gf-pinmap.md) |
  281. | `/gf-cocotb` | Generate Python testbench (Cocotb) | [gf-cocotb.md](plugins/gateflow/commands/gf-cocotb.md) |
  282. | `/gf-fusesoc` | Generate FuseSoC .core file | [gf-fusesoc.md](plugins/gateflow/commands/gf-fusesoc.md) |
  283. | `/gf-audit` | Audit plugin quality and optionally auto-fix issues | [gf-audit.md](plugins/gateflow/commands/gf-audit.md) |
  284. | `/gf-tui` | Open the local GateFlow terminal console | [gf-tui.md](plugins/gateflow/commands/gf-tui.md) |
  285. | `/gf-release` | Validate plugin release readiness | [gf-release.md](plugins/gateflow/commands/gf-release.md) |
  286. ### IP Library (8 verified blocks)
  287. | Block | Description | Includes |
  288. |-------|-------------|----------|
  289. | `fifo_sync` | Synchronous FIFO (parameterized width/depth) | RTL + TB + formal |
  290. | `fifo_async` | Async FIFO with Gray code pointers (CDC) | RTL + TB + formal |
  291. | `cdc_2ff` | 2-flip-flop synchronizer | RTL + TB + formal |
  292. | `cdc_handshake` | Multi-bit handshake synchronizer | RTL + TB + formal |
  293. | `uart` | UART TX+RX with configurable baud | RTL + TB + formal |
  294. | `spi_master` | SPI master (all 4 CPOL/CPHA modes) | RTL + TB + formal |
  295. | `axi4lite_slave` | AXI4-Lite register slave | RTL + TB + formal |
  296. | `debouncer` | Button debouncer with edge detection | RTL + TB + formal |
  297. Install with: `/gf-ip add fifo_sync` or "add a FIFO to my project"
  298. ### Board Database (4 boards)
  299. | Board | FPGA | Toolchain |
  300. |-------|------|-----------|
  301. | Digilent Arty A7-35T | Xilinx xc7a35t | Vivado / Yosys |
  302. | Digilent Basys 3 | Xilinx xc7a35t | Vivado / Yosys |
  303. | 1BitSquared iCEBreaker | Lattice iCE40UP5K | Yosys + nextpnr |
  304. | Sipeed Tang Nano 9K | Gowin GW1NR-9 | Yosys + nextpnr |
  305. Query with: `/gf-boards arty-a7-35t` or "what pins does the Arty A7 have?"
  306. Agents are automatically invoked by `/gf` based on your request — you don't need to call them directly.
  307. ---
  308. ## Individual Downloads
  309. Don't need the full plugin? Grab individual components.
  310. <details>
  311. <summary><b>How to download single components</b></summary>
  312. Each component is a standalone `.md` file. Download and drop into your plugin directory:
  313. ```
  314. your-plugin/
  315. ├── .claude-plugin/
  316. │ └── plugin.json
  317. ├── agents/ ← agent .md files
  318. ├── commands/ ← command .md files
  319. └── skills/
  320. └── skill-name/ ← SKILL.md files
  321. └── SKILL.md
  322. ```
  323. ### curl examples
  324. ```bash
  325. # Download an agent
  326. curl -O https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/agents/sv-codegen.md
  327. # Download a skill
  328. mkdir -p skills/gf-plan
  329. curl -o skills/gf-plan/SKILL.md https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/skills/gf-plan/SKILL.md
  330. # Download a command
  331. curl -O https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/commands/gf-lint.md
  332. ```
  333. > **Note:** Some skills (like `gf-plan`) include reference files in a `references/` subdirectory. For full functionality, download the entire skill folder.
  334. </details>
  335. ---
  336. ## Cross-Tool Compatibility
  337. GateFlow's skills and agents are plain Markdown — they work across AI coding tools.
  338. <details>
  339. <summary><b>Setup instructions for Codex, Cursor, Copilot, Cline, Windsurf</b></summary>
  340. ### OpenAI Codex CLI
  341. Codex uses the same `SKILL.md` format:
  342. ```bash
  343. # User-global
  344. mkdir -p ~/.codex/skills/gf-plan
  345. curl -o ~/.codex/skills/gf-plan/SKILL.md \
  346. https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/skills/gf-plan/SKILL.md
  347. # Repo-level
  348. mkdir -p .agents/skills/gf-lint
  349. curl -o .agents/skills/gf-lint/SKILL.md \
  350. https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/skills/gf-lint/SKILL.md
  351. ```
  352. | Location | Scope |
  353. |----------|-------|
  354. | `.agents/skills/` | Current repo |
  355. | `~/.codex/skills/` | User-global |
  356. | `/etc/codex/skills/` | System-wide |
  357. ### Cursor
  358. ```bash
  359. # Append to .cursorrules
  360. curl -s https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/agents/sv-codegen.md \
  361. >> .cursorrules
  362. # Or: Settings → Agent Modes → Add Custom Mode → paste agent content
  363. ```
  364. ### GitHub Copilot CLI
  365. ```bash
  366. mkdir -p .github
  367. curl -s https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/agents/sv-codegen.md \
  368. >> .github/copilot-instructions.md
  369. ```
  370. ### Cline
  371. ```bash
  372. curl -s https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/agents/sv-codegen.md \
  373. >> .clinerules
  374. ```
  375. ### Windsurf
  376. ```bash
  377. # As a rule
  378. mkdir -p .windsurf/rules
  379. curl -o .windsurf/rules/sv-codegen.md \
  380. https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/agents/sv-codegen.md
  381. # As a workflow
  382. mkdir -p .windsurf/workflows
  383. curl -o .windsurf/workflows/gf-plan.md \
  384. https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/skills/gf-plan/SKILL.md
  385. ```
  386. ### OpenCode
  387. OpenCode supports MCP servers and skill files:
  388. ```bash
  389. # Add GateFlow skills to your OpenCode config
  390. mkdir -p .opencode/skills/gf-plan
  391. curl -o .opencode/skills/gf-plan/SKILL.md \
  392. https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/skills/gf-plan/SKILL.md
  393. # Add agent definitions
  394. curl -O https://raw.githubusercontent.com/codejunkie99/Gateflow-Plugin/main/plugins/gateflow/agents/sv-codegen.md
  395. ```
  396. ### Quick Reference
  397. | Tool | Where to Put Files | Format |
  398. |------|-------------------|--------|
  399. | **Claude Code** | Plugin `skills/`, `agents/`, `commands/` | Native |
  400. | **Codex CLI** | `~/.codex/skills/` or `.agents/skills/` | SKILL.md |
  401. | **Cursor** | `.cursorrules` or custom agent mode | Append |
  402. | **Copilot CLI** | `.github/copilot-instructions.md` | Append |
  403. | **Cline** | `.clinerules` | Append |
  404. | **Windsurf** | `.windsurf/rules/` or `.windsurf/workflows/` | Individual .md |
  405. | **OpenCode** | `.opencode/skills/` or MCP | SKILL.md / Agent .md |
  406. </details>
  407. ---
  408. ## Configuration
  409. Create `.claude/gateflow.local.md` in your project for project-specific settings:
  410. ```yaml
  411. ---
  412. verilator_flags: ["-Wall", "-Wno-UNUSED"]
  413. top_module: chip_top
  414. clock_freq: 100MHz
  415. ---
  416. # Project Notes
  417. - Memory mapped registers at 0x1000
  418. - AXI4-Lite interface for config
  419. ```
  420. ---
  421. ## Project Structure
  422. ```
  423. Gateflow-Plugin/
  424. ├── plugins/gateflow/ # Main plugin source
  425. │ ├── .claude-plugin/ # Plugin manifest
  426. │ ├── agents/ # 20 specialized AI agents
  427. │ ├── commands/ # 21 slash commands
  428. │ ├── skills/ # 27 auto-activating skills
  429. │ ├── hooks/ # Automation hooks + session tracking
  430. │ ├── boards/ # Curated FPGA board database (4 boards)
  431. │ ├── ip/ # Verified IP block library (8 blocks)
  432. │ └── CLAUDE.md # SystemVerilog reference
  433. ├── agents/ # Mirrored agent entrypoints (symlinks)
  434. ├── skills/ # Mirrored skill entrypoints (symlinks)
  435. ├── docs/ # Compressed docs index
  436. ├── CLAUDE.md # SV reference (repo-level)
  437. └── AGENTS.md # Docs index for non-Claude agents
  438. ```
  439. | File | For |
  440. |------|-----|
  441. | `CLAUDE.md` | Claude Code (primary reference) |
  442. | `AGENTS.md` | Other AI agents (Cursor, Copilot, etc.) |
  443. ---
  444. ## Troubleshooting
  445. <details>
  446. <summary><b>"Verilator not found"</b></summary>
  447. ```bash
  448. verilator --version # Check if installed
  449. brew install verilator # macOS
  450. sudo apt install verilator # Linux (Debian/Ubuntu)
  451. ```
  452. </details>
  453. <details>
  454. <summary><b>"Plugin not loading"</b></summary>
  455. ```bash
  456. claude --plugin-dir /path/to/Gateflow-Plugin/plugins/gateflow
  457. ls /path/to/Gateflow-Plugin/plugins/gateflow/.claude-plugin/plugin.json
  458. ```
  459. </details>
  460. <details>
  461. <summary><b>"Agent not found"</b></summary>
  462. Use the `gateflow:` prefix when spawning agents manually:
  463. ```
  464. gateflow:sv-codegen
  465. gateflow:sv-testbench
  466. ```
  467. </details>
  468. ---
  469. ## Updates
  470. For detailed release notes, see [`releases.md`](releases.md).
  471. | Version | Date | What Changed |
  472. |---------|------|-------------|
  473. | **2.5.3** | 2026-05-21 | Command-first local CLI, interactive agent creation, and richer terminal colors |
  474. | **2.5.2** | 2026-05-21 | Responsive TUI layout for narrow terminal windows |
  475. | **2.5.1** | 2026-05-21 | TUI terminal compatibility fixes for cursor and colorless PTYs |
  476. | **2.5.0** | 2026-05-21 | OpenClaw-style CLI/TUI, release readiness workflow, deterministic validators, synced marketplace/docs/index/mirrors |
  477. | **2.4.0** | 2026-04-11 | Deep skill enrichment across verification, synthesis, orchestration, architecture, learning, IP, and planning |
  478. | **2.3.0** | 2026-03-27 | Quality pass, expanded IP docs, new commands, and component reference fixes |
  479. | **2.2.1** | 2026-03-26 | IP auto-detection, auto-fill, CDC scanning, and `sv-ip-scanner` |
  480. | **2.2.0** | 2026-03-26 | Community guides, KiCad, Cocotb, FuseSoC, CI templates, and ecosystem integrations |
  481. | **2.1.0** | 2026-03-26 | VHDL, pin mapping, place and route, FPGA flash, and protocol scaffolding |
  482. | **2.0.0** | 2026-03-26 | Formal verification, synthesis, IP library, and board database |
  483. | **1.6.0** | 2026-03-26 | Version sync across plugin.json and marketplace.json; BSL-1.1 license confirmed |
  484. | **1.5.3** | 2026-02-18 | Replace prompt-based PostToolUse hook with deterministic Python script |
  485. | **1.5.2** | 2026-02-15 | Fix Stop hook JSON validation: replace prompt hook with deterministic command hook (non-blocking reminder) |
  486. | **1.5.0** | 2025-02-11 | Terminal visualization with `/gf-viz` skill and `sv-viz` agent |
  487. | **1.4.4** | 2025-02-11 | Individual component downloads, cross-tool install instructions |
  488. | **1.4.3** | 2025-02-10 | Split `gf-plan` references, validation fixes, docs improvements |
  489. ---
  490. ## Contributing
  491. Contributions welcome! Areas we'd love help with:
  492. - **Board definitions**: Add your FPGA board to `plugins/gateflow/boards/`
  493. - **IP blocks**: Submit verified blocks to `plugins/gateflow/ip/`
  494. - **Protocol support**: AXI4-Full, PCIe, USB, Ethernet, Wishbone
  495. - **Tool integrations**: Cocotb, FuseSoC, Edalize
  496. - **Documentation and examples**
  497. ---
  498. ## License
  499. BSL-1.1 (Business Source License) — see [LICENSE](LICENSE) for details.
  500. **You can:** Use, fork, contribute for non-commercial/personal/educational purposes.
  501. **Commercial use:** Contact us for a license.
  502. **After 2028:** Converts to Apache 2.0.
  503. ---
  504. ## Links
  505. - [Claude Code Documentation](https://code.claude.com/docs)
  506. - [Verilator](https://verilator.org/)
  507. - [SystemVerilog LRM](https://ieeexplore.ieee.org/document/8299595)
  508. ---
  509. ## Star History
  510. [![Star History Chart](https://api.star-history.com/svg?repos=codejunkie99/Gateflow-Plugin&type=date&legend=top-left)](https://www.star-history.com/#codejunkie99/Gateflow-Plugin&type=date&legend=top-left)
  511. ---
  512. <p align="center">
  513. <b>Built for hardware engineers who want to move faster.</b><br>
  514. <i>Design. Verify. Ship.</i>
  515. </p>

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.