ros2inspector scan
Discover ROS2 packages and display a health-scored workspace summary.
Usage
ros2inspector scan [PATH] [--format table|json|yaml]
PATH is positional and defaults to the current directory.
Options
| Option | Default | Description |
|---|---|---|
--format, -f | table | Output as a Rich table, JSON, or YAML |
Examples
ros2inspector scan
ros2inspector scan ~/robot_ws
ros2inspector scan ~/robot_ws --format json
The table includes package name, version, package type, license, maintainers, and the 0–100 health score. JSON and YAML return the serialized package metadata list.
What contributes to health
The score checks package metadata and repository hygiene, including description, license, maintainers, non-default version, README, tests, launch files, self-dependencies, and circular dependencies.