Skip to main content

ros2inspector audit

Run built-in architecture checks without creating a policy file.

Usage

ros2inspector audit [PATH] [OPTIONS]

PATH is positional and defaults to the current directory.

Built-in checks

  • topics with subscribers but no publisher;
  • topics with publishers but no subscriber;
  • nodes with no detected communication;
  • services missing a provider or client counterpart;
  • actions missing a server or client counterpart.

Common ROS system topics such as /rosout, /parameter_events, /clock, /tf, and /tf_static are excluded by default.

Options

OptionDefaultDescription
--format, -ftabletable, json, or yaml
--fail-onerrorExit 1 for error, warning, or info and above
--strictfalseTreat warnings as failure-triggering findings
--excludeComma-separated additional topic names to ignore
--no-cachefalseRe-parse source

Examples

ros2inspector audit
ros2inspector audit ~/robot_ws --fail-on warning
ros2inspector audit --strict
ros2inspector audit --exclude /debug_pose,/legacy_cmd --format json