rostree 0.2.0

Explore ROS 2 package dependencies from the command line (CLI, TUI, library)

██████╗  ██████╗ ███████╗████████╗██████╗ ███████╗███████╗
██╔══██╗██╔═══██╗██╔════╝╚══██╔══╝██╔══██╗██╔════╝██╔════╝
██████╔╝██║   ██║███████╗   ██║   ██████╔╝█████╗  █████╗
██╔══██╗██║   ██║╚════██║   ██║   ██╔══██╗██╔══╝  ██╔══╝
██║  ██║╚██████╔╝███████║   ██║   ██║  ██║███████╗███████╗
╚═╝  ╚═╝ ╚═════╝ ╚══════╝   ╚═╝   ╚═╝  ╚═╝╚══════╝╚══════╝

Explore ROS 2 package dependencies from the command line (CLI, TUI, library).

Docs: docs/README.md — overview, package discovery, dependency trees, usage, development.

Quick start

pip install -e .   # or: uv pip install -e .
source /opt/ros/<distro>/setup.bash   # and/or your workspace install/setup.bash

CLI commands

rostree                      # Launch interactive TUI
rostree scan                 # Scan host for ROS 2 workspaces
rostree scan ~/dev --depth 3 # Scan specific directories
rostree list                 # List known packages
rostree list --by-source     # List packages grouped by source
rostree tree rclpy           # Show dependency tree for a package
rostree tree rclpy --depth 3 # Limit tree depth
rostree tree rclpy --json    # Output as JSON
rostree graph rclpy --render png       # Generate PNG image (requires graphviz)
rostree graph rclpy --render svg --open # Create SVG and open it
rostree graph -w ~/ros2_ws --render png # Graph entire workspace to image
rostree graph rclpy -f mermaid         # Mermaid format (text)

TUI mode

rostree tui                  # Interactive terminal UI
rostree tui rclpy            # Start TUI with a specific package tree

Python API

from rostree import list_known_packages, get_package_info, build_tree, scan_workspaces

packages = list_known_packages()
root = build_tree("rclpy", max_depth=5, runtime_only=True)
workspaces = scan_workspaces()  # Scan host for ROS 2 workspaces

Links

• How the system works
• How packages are found (workspaces, AMENT_PREFIX_PATH, COLCON_WORKSPACE)
• Dependency trees (package.xml, runtime_only)
• Usage (CLI, TUI keys, API)
• Development (layout, pre-commit, CI)