CLI Reference
ROS2 Inspector v0.1.0 ships seven commands for static workspace discovery, architecture visualization, auditing, and policy enforcement.
Global usage
ros2inspector [OPTIONS] COMMAND [ARGS]...
Commands
| Command | Purpose |
|---|---|
scan | Discover packages and show workspace health |
packages | Inspect package metadata and dependencies |
nodes | List statically detected nodes and endpoints |
graph | Render dependency, communication, or full graphs |
viz | Generate a self-contained interactive HTML graph |
audit | Run built-in connectivity and isolation checks |
validate | Enforce a YAML architecture policy |
Global options
| Option | Purpose |
|---|---|
--version, -v | Print the installed version and exit |
--quiet, -q | Suppress diagnostic headers and progress output |
--help | Show command help |
Output formats
scan,packages,nodes,audit, andvalidate: table, JSON, or YAML where documented.graph: Mermaid, GraphViz DOT, or JSON.viz: self-contained HTML.
Exit codes
| Code | Meaning |
|---|---|
0 | Command completed and no configured failure threshold was reached |
1 | audit or validate found results at or above --fail-on |
2 | Invalid invocation or invalid policy configuration |
3 | Workspace packages or the requested policy file could not be found |