# WireViz

**WireViz** is an open‑source tool for documenting cables, wiring harnesses, and connector pinouts using plain text input and automatically generated diagrams and bills of materials.

WireViz lets you describe cables, connectors, and how each wire is connected using a structured YAML text file, then renders a wiring diagram. It is built on top of Graphviz, which it uses to create the graphical representation of the harness.

[Learn more about WireViz](https://github.com/wireviz/WireViz)

## [#](#examples)Examples

### [#](#simple-cable-diagram)Simple Cable Diagram

![WireViz Diagrams in Confluence](https://help.gocapable.com/images/5a05c840-63e3-421e-abb2-dcf25b1b1262.webp)

```
connectors:
  X1:
    pincount: 4
  X2:
    pincount: 4

cables:
  W1:
    wirecount: 4
    length: 1

connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1-4]
```

### [#](#colors-and-non-sequential-pins)Colors and non-sequential pins

![WireViz Diagrams in Confluence](https://help.gocapable.com/images/65bc066a-1580-4b13-b7c2-ef514eb9beb4.webp)

```
connectors:
  X1:
    pincount: 4
    type: Molex KK 254
    subtype: female
  X2:
    pincount: 4
    type: Molex KK 254
    subtype: female

cables:
  W1:
    wirecount: 4
    length: 1
    gauge: 0.25 mm2
    colors: [WH, BN, GN, YE]

connections:
  -
    - X1: [1-4]
    - W1: [1-4]
    - X2: [1,2,4,3
```

### [#](#bundles-with-ferrules)Bundles with ferrules

![WireViz Diagrams in Confluence](https://help.gocapable.com/images/a7ca4628-c51e-4921-91d9-f38ec102879c.webp)

```
connectors:
  X1:
    pinlabels: [+12V, GND, GND, +5V]
    type: Molex 8981
    subtype: female

cables:
  W1:
    category: bundle
    length: 0.3
    gauge: 0.5 mm2
    colors: [YE, BK, BK, RD]

connections:
  -
    - W1: [1-4]
    - X1: [1-4]
```