| Syntax | Description | Example |
|---|---|---|
[ Node ] |
Create a node | [ Server ] |
-> |
Directed edge | [ A ] -> [ B ] |
<-> |
Bidirectional edge | [ A ] <-> [ B ] |
-- |
Undirected edge | [ A ] -- [ B ] |
{ label: text; } |
Edge label | -> { label: yes; } |
( Group ) |
Node group | ( Frontend ) |
Understanding Graph-Easy
What is Graph-Easy?
Graph-Easy is a Perl library that converts simple text notation into beautiful ASCII art diagrams. Originally created by Tels, it's widely used for documenting software architecture, creating flowcharts in documentation, and generating diagrams that can be embedded in plain text files like README files.
Output Formats
ASCII Art
Classic text-based diagrams using +, -, |, and other ASCII characters. Works everywhere.
Box Art
Uses Unicode box-drawing characters for cleaner, professional-looking diagrams.
GraphViz DOT Export
DOT format with PNG/SVG/PDF export via Viz.js rendering.
HTML Preview
HTML table output with live preview. Toggle to view source code.
Common Use Cases
- Documentation: Create architecture diagrams that live alongside your code
- README files: Add visual flowcharts to project documentation
- System design: Quickly sketch component relationships
- Process flows: Document workflows and decision trees
- Git workflows: Visualize branching strategies
Syntax Examples
Simple Chain
With Labels
Bidirectional
Groups
Graph-Easy vs Other Diagram Tools
| Feature | Graph-Easy | Mermaid | PlantUML | ASCII Flow |
|---|---|---|---|---|
| ASCII Art Output | Native | No | Limited | Yes |
| PNG/SVG Export | Yes | Yes | Yes | No |
| README Compatible | Perfect | Needs render | Needs render | Yes |
| No Server Required | Browser only | Yes | Needs Java | Yes |
| Learning Curve | Easy | Medium | Medium | Visual/Easy |
| Best For | Docs, README, Terminal | Web docs, Markdown | UML, Complex diagrams | Quick sketches |
Who Uses This Tool?
- Press Ctrl+Enter (or Cmd+Enter on Mac) to quickly render your graph.
- Select GraphViz DOT format to export your diagram as PNG, SVG, or PDF.
- Select HTML format to see a live preview — toggle between preview and source code.