ROS 2 Debugging Assistant CLI

A self-contained command-line tool that provides access to a powerful ROS 2 debugging assistant.

Installation

npm install -g ros2-debug-cli

That's it! No need to install any additional dependencies - the CLI will handle everything for you.

Prerequisites

• ROS 2 (Humble or Jazzy) properly installed and configured
• Python 3.8+ with pip
• Node.js 14+ and npm
• OpenAI API key - Required for AI-powered analysis

Usage

Start the debugging assistant

ros2-debug

This will:

1. Check for required dependencies and install them if needed
2. Launch the ROS 2 Debugging Assistant
3. Open your browser to the assistant's web interface

For the assistant to work properly, you need to set your OpenAI API key:

export OPENAI_API_KEY=your_key_here
ros2-debug

Register your license key

ros2-debug register YOUR_LICENSE_KEY

Check license status

ros2-debug status

Using the assistant

Once the assistant launches in your browser, you can:

1. Use the chat interface to ask questions about your ROS 2 system
2. Try commands like:
   • "List all ROS 2 nodes"
   • "List all ROS 2 topics"
   • "List all ROS 2 services"
3. Use the sidebar tools to:
   • Browse ROS 2 nodes
   • Inspect topics
   • View service information
   • Run custom ROS 2 commands

Features

• Interactive debugging for ROS 2 systems
• No need to install or set up a separate RAI environment
• Commands to explore ROS 2 nodes, topics, services, and actions
• Built-in tools to run custom ROS 2 commands
• Sleek web interface built with Streamlit

Version History

• 1.3.0: Integrated OpenAI API for advanced analysis of ROS 2 systems
• 1.2.1: Fixed infinite loop issue in chat interface
• 1.2.0: Improved chat interface responsiveness and fixed message display issues
• 1.1.0: Added standalone assistant that doesn't require RAI repository
• 1.0.0: Initial release with basic functionality

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Support

For support, please open an issue on our GitHub repository.