Guide · Open source
How to use fireworks-tech-graph: generate SVG and PNG diagrams
Updated · written with AI from the project's own documentation and checked against our catalogue data
fireworks-tech-graph is an open-source Agent Skill that works in Codex and Claude Code. You describe a system in English or Chinese and it generates SVG diagrams, PNG exports, short GIF flow animations and offline interactive HTML diagrams. This guide shows how to get the repository, what you need installed, and how to ask for a diagram and check the result.
Quick start
- 1Install prerequisites. Make sure Python 3 is installed and that you have Claude Code or Codex set up.
- 2Clone the repository. Run the git clone command from the README to download fireworks-tech-graph from GitHub.
- 3Check the tool. Run the version command, then doctor, to confirm which features your setup supports.
- 4Describe your system. In Claude Code or Codex, describe the system in English or Chinese and name the diagram type and style.
- 5Review the output. Open the generated SVG or PNG and check labels, arrows and layout before you publish it.
- 6Export a PNG if needed. Run export-png with the SVG path, output path and a width to produce a high-resolution image.
What you need before you start
The README lists two prerequisites: Python 3, and either Claude Code or Codex. The project is framed as an Agent Skill for those tools, so you will run it from inside one of them rather than as a standalone desktop app.
- Python 3
- Claude Code or Codex
- Git, to clone the repository
Get the fireworks-tech-graph repository
The README's install step is to clone the repository from GitHub. The project is licensed under MIT and its main language is Python. The README does not give further install steps in the source provided, so check the repository for any setup notes before relying on it.
git clone https://github.com/yizhiyanhua-ai/fireworks-tech-graphCheck the tool and its PNG support
The README describes two commands. The version command reports the package, the actual Skill root and Git state when available. The doctor command distinguishes SVG and HTML support from optional PNG and GIF dependencies, so run it if you need PNG or GIF output. The README also notes a browser PNG exporter for Chromium fidelity.
- version reports package, Skill root and Git state
- doctor separates SVG/HTML support from optional PNG/GIF dependencies
- export-png takes an SVG path, an output PNG path and a --width value
python3 "$SKILL_ROOT/scripts/fireworks.py" version
python3 "$SKILL_ROOT/scripts/fireworks.py" export-png diagram.svg diagram.png --width 1920Describe the diagram you want
Ask for the system in plain language inside Claude Code or Codex. Name the kind of diagram and, if you want one, the style. The README's example asks for a Mem0 memory architecture diagram in a dark style, and the skill classifies it, generates an SVG with swim lanes and semantic arrows, exports a 1920px PNG and reports the file names.
The project ships 12 visual styles, including Flat Icon (the default), Dark Terminal, Blueprint, Claude Official and OpenAI Official. It also supports 14 UML diagram types and AI/agent workflow patterns.
- Name the system and its main parts
- Say whether you want architecture, flow, C4, cloud deployment or UML
- Pick a style by name or number
Use strict text checking for labels
The README says that adding "text_policy": "strict" rejects visible truncation before output is written. Reports keep the full source label and explain how to recover. Chinese descriptions use the available second line.
The README also states measurement limits for text fit, so review the output rather than assuming pixel-perfect layout.
- Add "text_policy": "strict" to reject truncated labels
- Review the generated image before using it in documentation
Choose the right output
Each run can produce an SVG, a high-resolution PNG, a short GIF animation of a diagram flow, or an offline interactive HTML diagram. The GIF path accepts a generated semantic SVG and emits one compact GIF. Use SVG when you want to keep editing source, PNG for static docs, and HTML for interactive viewing.
- SVG: scalable source for docs
- PNG: static export, width set with --width
- GIF: animated flow from a semantic SVG
- HTML: offline interactive diagram
What people use it for
- Architecture diagrams for a developer's own system, described in text inside Claude Code or Codex
- C4, cloud deployment or reliability review diagrams for engineering documentation
- Diagrams of AI agent or memory architectures
- Consistent diagram styles across a team's documentation set
Frequently asked questions
Is fireworks-tech-graph free?
The repository is licensed under MIT, as shown in the README. The source does not list prices for the sponsor's service or any other cost, so the licence is the only licensing information here.
What do I need to install fireworks-tech-graph?
The README lists Python 3 and either Claude Code or Codex as prerequisites. The install step given is to clone the GitHub repository.
Can I use fireworks-tech-graph without Claude Code or Codex?
The README frames the project as an Agent Skill for Codex and Claude Code, so it is designed to run inside those tools. The source does not describe a standalone mode.
Does it have a drag-and-drop editor?
No. The README describes generating diagrams from natural language rather than an interactive editing interface. Tools like Excalidraw are closer to that model.
How does it compare to Mermaid, PlantUML or Graphviz?
Mermaid, PlantUML, Excalidraw and Graphviz are listed as comparable projects. fireworks-tech-graph differs in that it generates diagrams from a natural-language description inside an AI coding tool, rather than from diagram source code you write yourself.
Why does the PNG look cut off or misplaced?
The README notes measurement limits for text fit and recommends reviewing output. Add "text_policy": "strict" to reject visible truncation before output is written, then check the generated file.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Use fireworks-tech-graph if you work in Claude Code or Codex and want architecture, flow, C4 or AI agent diagrams generated from a text description with consistent styles. Pick a drag-and-drop editor or a code-based tool such as Mermaid, PlantUML or Graphviz if you need hands-on editing or guaranteed exact layout.
Install options & downloads