# @x12i/graphenix-dot

> Convert Graphenix graph documents, executable plans, and traces to Graphviz DOT language.

Latest version **2.17.0** (published 2026-07-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @x12i/graphenix-dot
pnpm add @x12i/graphenix-dot
yarn add @x12i/graphenix-dot
bun add @x12i/graphenix-dot
```

## Health

**Score 60/100 (C)** — status: active.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 2.17.0 |
| Published | 2026-07-10 |
| First published | 2026-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 54.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | x12i |
| Keywords | graph, graphenix, graphviz, dot, visualization |

## Links

- npm: https://www.npmjs.com/package/@x12i/graphenix-dot
- Repository: https://github.com/x12i/graphenix-format
- Homepage: https://github.com/x12i/graphenix-format/tree/master/packages/dot-format#readme
- Issues: https://github.com/x12i/graphenix-format/issues
- npm.io page: https://npm.io/package/@x12i/graphenix-dot

## Dependencies (1)

- [@x12i/graphenix-executable-contracts](https://npm.io/package/@x12i/graphenix-executable-contracts.md) ^2.17.0

## Alternatives

- [d3-force-3d](https://npm.io/package/d3-force-3d.md) — 1.0M weekly downloads
- [ng2-charts](https://npm.io/package/ng2-charts.md) — 486.8K weekly downloads
- [@arcgis/core](https://npm.io/package/@arcgis/core.md) — 257.8K weekly downloads
- [react-sparklines](https://npm.io/package/react-sparklines.md) — 249.3K weekly downloads
- [react-native-gifted-charts](https://npm.io/package/react-native-gifted-charts.md) — 182.3K weekly downloads

## Recent versions

- 2.17.0 (latest) — 2026-07-10
- 2.16.0 — 2026-06-29
- 2.15.0 — 2026-06-29
- 2.14.0 — 2026-06-28
- 2.12.5 — 2026-06-28
- 2.12.4 — 2026-06-28
- 2.12.3 — 2026-06-27
- 2.12.2 — 2026-06-27
- 2.12.0 — 2026-06-27

## README

# @x12i/graphenix-dot

Convert Graphenix graph documents and executable lifecycle artifacts to **Graphviz DOT** language for visualization, debugging, and documentation.

DOT output can be rendered with the [Graphviz](https://graphviz.org/) `dot` CLI or any compatible viewer:

```bash
npm install @x12i/graphenix-dot @x12i/graphenix-core
```

```ts
import { graphenixToDot, executablePlanToDot, toDot } from "@x12i/graphenix-dot";
import { createMinimalExecutableGraph } from "@x12i/graphenix-authoring-format";

const doc = createMinimalExecutableGraph();
const dot = graphenixToDot(doc, { includeNodeParameters: true });

// Write to a file and render:
// dot -Tsvg graph.dot -o graph.svg
```

## Supported inputs

| Function | Input | Purpose |
| -------- | ----- | ------- |
| `graphenixToDot` | `GraphDocument` / authoring graph | Design-time topology with graph inputs/outputs |
| `executablePlanToDot` | `ExecutableGraphPlanV2` | Compiled plan topology (+ optional execution units) |
| `toDot` | Either of the above | Auto-dispatch by artifact shape |
| `graphenixToDotWithTrace` | graph + `GraphExecutionTraceV2` | Color nodes by run status |
| `executablePlanToDotWithTrace` | plan + trace | Same overlay on compiled topology |

## Options

Common options (`DotRenderOptions`):

- `direction` — layout direction (`LR`, `TB`, …). Default: `LR`.
- `includeGraphInputs` / `includeGraphOutputs` — boundary nodes for graph ports. Default: `true`.
- `includePortLabels` — show port ids on edges. Default: `true`.
- `includeNodeParameters` — include skill/finalizer hints in labels. Default: `false`.
- `includeSubgraphs` — render document subgraphs as DOT clusters. Default: `true`.
- `useLayout` — emit `pos` from Graphenix `node.layout` (use with `neato`/`fdp`). Default: `false`.

Plan-specific options:

- `includeExecutionUnits` — nested cluster per node showing PRE/MAIN/POST units.
- `highlightDeferredGates` — dashed edges where the plan has deferred gates.

Trace overlay uses default fill colors (pending gray, running yellow, completed green, failed red, skipped light gray). Override via `statusColors`.

## Dependencies

- **Peer:** `@x12i/graphenix-core`
- **Runtime:** `@x12i/graphenix-executable-contracts` (plan/trace types)

This package generates DOT text only. It does not bundle Graphviz binaries.

## License

MIT

---
_Source: https://npm.io/package/@x12i/graphenix-dot · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._