rtui icon indicating copy to clipboard operation
rtui copied to clipboard

TUI tool for ROS

rtui

rtui is ROS Terminal User Interface

Support

  • Python
    • 3.8+
    • Latest Poetry does not support Python 3.6
  • ROS1
    • melodic (Need to use python3.8)
    • noetic
  • ROS2
    • foxy+

Install

Via pipx (Recommended)

$ pipx install git+https://github.com/eduidl/rtui.git

# melodic
$ pipx install --python python3.8 git+https://github.com/eduidl/rtui.git

Pip

$ pip3 install --user git+https://github.com/eduidl/rtui.git

# melodic
$ python3.8 -m pip install --user git+https://github.com/eduidl/rtui.git

Demo

demo

Usage

$ rtui --help
Usage: rtui [OPTIONS] COMMAND [ARGS]...

  Terminal User Interface for ROS User

Options:
  --help  Show this message and exit.

Commands:
  actions   Inspect ROS actions (ROS1 is not supported)
  nodes     Inspect ROS nodes
  services  Inspect ROS services
  topics    Inspect ROS topics
  • nodes/topics/services/actions
    • get a list of nodes, topics, or etc.
    • get an information about specific node, topic, or etc.
    • mouse operation
      • click link of a node, a topic, or etc.
    • keyboard operation
      • b/f: Trace history backward and forward
      • r: Once more get list of nodes, topics or etc.
      • e: Start or finish topic subscriptions
      • q: Terminate app