Skip to main content

A TUI for ROS 2

Project description

ROS 2 Window Manager TUI (ros2tui)

A high-performance, asynchronous Text User Interface (TUI) designed for ROS 2 Humble. This tool transforms your terminal into a tiling window manager specifically tuned for robotics development. Navigate your workspace, monitor topics, and manage multiple nodes side-by-side using pure keyboard motions.


🚀 Key Features

  • Ament-Aware Fuzzy Discovery: Instantly find executables and launch files by scanning the ament_index. No more "trash" suggestions from standard bash completion.
  • Tiling Workspace: Split your view into multiple independent panes to monitor topic echo, node info, and launch logs simultaneously.
  • Vim-Powered Navigation: Full hjkl support for tree navigation, log scrolling, and Ctrl + h/l for lightning-fast pane switching.
  • Robust Process Management: Uses Unix process groups (os.killpg) to ensure that killing a ros2 launch command actually cleans up all child nodes.
  • Search-to-Select Workflow: Seamless focus transition from the fuzzy-search bar to the command tree using only the Enter key.

📦 Installation

Prerequisites

  • Ubuntu 22.04
  • ROS 2 Humble (Sourced)
  • Python 3.10+

1. From Source

To install in "editable" mode so that changes to the code take effect immediately:

git clone [https://github.com/YOUR_USERNAME/ros2tui.git](https://github.com/YOUR_USERNAME/ros2tui.git)
cd ros2tui
pip install -e .

2. From Pip (Recommended)

You can install ros2tui directly from PyPI:

pip install ros2tui
source /opt/ros/humble/setup.bash
# (Optional) Source your workspace
source ~/your_ws/install/setup.bash

Running the TUI

If ROS2 is sourced in your workspace

**ros2tui**

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

h20tui-0.1.0.tar.gz (7.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

h20tui-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file h20tui-0.1.0.tar.gz.

File metadata

  • Download URL: h20tui-0.1.0.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for h20tui-0.1.0.tar.gz
Algorithm Hash digest
SHA256 712df58fca0c9f86976973afe79cbc4b6532b851fc4a42660988ab5ce9b3d7e5
MD5 b89b13275ed55f8d51d822485b804228
BLAKE2b-256 a3cf039972a99235066bb4e250b269a7461ff7da9735063ff3b1889dc6926307

See more details on using hashes here.

File details

Details for the file h20tui-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: h20tui-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for h20tui-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f4d93658e147414c85f075b47e35d9c1400ccca40cb2214caa706c271377547a
MD5 2854d9748cdaf731f18ac86fd165627c
BLAKE2b-256 66f3c31c369b967c5e054a40df7449e1d51a4cf6a8ed2a7c525be06e871bbb78

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page