Workflow inventory
The report summarizes nodes, types, versions, triggers, disabled state and safe structural key names.
Day 060 / n8n / Workflow Automation
n8n Workflow Documenter
/ Overview
A dependency-free Python CLI that turns a local n8n export into data-minimized Markdown or JSON workflow documentation.
An exported n8n workflow is useful for backup and transfer, but its nested JSON is difficult to review as a process map. Copying the raw export into documentation can also expose parameter values or credential identifiers that the reader does not need.
/ Provided servicesClear thinking.
Clear thinking.
Practical delivery.
Connection map
Every exported edge records its source, target, output and input index, with missing target nodes highlighted for review.
Privacy boundary
Parameter values and credential identifiers never enter the generated document; only key and credential-type names are listed.
/ Solution
n8n Workflow Documenter validates one bounded local export and produces Markdown or JSON documentation for nodes, node types, versions, trigger status, connection paths, disconnected nodes, broken target references, parameter key names, credential types and workflow setting keys. It omits parameter values and credential identifiers, rejects duplicate keys and node names, and returns distinct exit codes for clean, structurally incomplete and invalid exports. It does not connect to n8n, run workflows, read executions or certify business logic.
/ Impact
Markdown and JSON references
Node and edge inventory
Disconnected-node detection
Broken-reference detection
Value-minimized documentation
Python standard library
Argparse, dataclasses, JSON and unittest keep the command portable and dependency-free.
Bounded graph parsing
The parser limits file size, node count and edge count while rejecting duplicate keys and malformed connection shapes.
Twelve tests
Tests cover nodes, edges, triggers, disconnected and broken references, minimized output, duplicate data and file writing.