ros2inspector graph
Render the workspace architecture as a dependency graph, communication graph, or complete Unified Architecture Model.
Usage
ros2inspector graph [deps|comms|full] [-C PATH] [OPTIONS]
The graph type defaults to deps.
Options
| Option | Default | Description |
|---|---|---|
-C, --path | . | Workspace root |
--format, -f | mermaid | mermaid, dot, or json |
--output, -o | — | Write output to a file |
--package, -p | — | Focus on one package and its immediate neighbors |
--no-cache | false | Re-parse source |
Graph types
| Type | Included information |
|---|---|
deps | Packages and depends_on relationships |
comms | Nodes, topics, services, actions, and communication edges |
full | Every UAM entity and relationship |
Examples
ros2inspector graph
ros2inspector graph comms --format mermaid -o architecture.mmd
ros2inspector graph full --format dot | dot -Tsvg -o architecture.svg
ros2inspector graph deps --format json -p navigation2