User guide

How to author, read, check and export diagrams with archify-gcp.

If you want to…	Read
Install and render something	Getting started
Describe an architecture (groups, nodes, edges, layout)	Architecture diagrams
Show a flow over time or a data pipeline	Sequence and dataflow
Explore a generated page	Viewer and numbered callouts
Know what it costs	Cost estimate
Review it against the Well-Architected Framework	Well-Architected review
Get PNG, SVG or an editable draw.io file	Exporting
Start from Mermaid, Terraform, CloudFormation or SAM	Importers
Prove the output is sound	Quality gates
Let an AI agent do all of this	Using it from an AI agent
Look up a command	CLI reference
Fix a problem	Troubleshooting

The workflow in one picture

spec.json ──validate──▶ layout + routing ──▶ SVG ──┬──▶ HTML page  (Diagram · Cost · Well-Architected)
                                                   ├──▶ PNG
                                                   ├──▶ draw.io
                                                   └──▶ receipt.json
              cost estimate (Cloud Billing Catalog) ──────┘
              review (WA Framework + GenAI Lens) ──┘

finalize runs the whole chain and refuses to succeed if any gate fails. See Quality gates.