Installation
Requirements
| Requirement | Version |
|---|---|
| Python | 3.11, 3.12, or 3.13 |
| ROS2 | Not required for static analysis |
| OS | Linux is release-tested; validate other platforms before production use |
:::info No runtime needed Static analysis works locally and does not require a sourced ROS2 environment. The visualization asset is bundled for offline output. :::
Install with pipx (recommended)
pipx installs
ros2inspector in an isolated environment and makes the command available on your
PATH. You do not need to create or activate a virtual environment.
pipx install ros2inspector
Verify the installation:
ros2inspector --version
If the command is not found after installation, run pipx ensurepath and open a
new terminal.
Install with pip in a virtual environment
python -m venv .venv
source .venv/bin/activate
pip install ros2inspector
Install from source
git clone https://github.com/aminebensaid66/ros2_inspector.git
cd ros2_inspector
pip install -e .
Dependencies
These are installed automatically with ros2inspector:
| Package | Purpose |
|---|---|
typer | CLI framework |
rich | Terminal output formatting |
networkx | Graph operations and cycle detection |
pydantic | Data validation |
pyyaml | Policy file parsing |
orjson | Fast JSON serialization |
tree-sitter + tree-sitter-cpp | C++ AST parsing |
diskcache | Incremental analysis caching |
Next steps
- Quick Start — Run your first scan in under 2 minutes
- Compatibility and Scope — Review tested environments and parser limits
- Core Concepts — Understand what ros2inspector discovers and how