This is a Visual Studio Code Extension that provides debugging support for Robot Operating System (ROS 1) development. The Robot Operating System is a trademark of Open Robotics.
NOTE: This extension is rebranded and re-released by Ranch Hand Robotics, a company owned by the maintainer of the ms-iot VSCode ROS Extension with permission from Microsoft. The source extension was split into 3 parts - ROS 1, ROS 2 and a URDF/Xacro editor.
- Automatic ROS environment configuration.
- Allows starting, stopping and viewing the ROS core status.
- Automatically create
catkin_makeorcatkin buildbuild tasks. - Create catkin packages using
catkin_create_pkgscript orcatkin create pkg. - Run
rosrunandroslaunch - Resolve dependencies with
rosdepshortcut - Syntax highlighting for
.msg,.urdfand other ROS files. - Automatically add the ROS C++ include and Python import paths.
- Format C++ using the ROS
clang-formatstyle. - Debug a single ROS node (C++ or Python) by attaching to the process.
- Debug ROS nodes (C++ or Python) launched from a
.launchfile. - Support for Visual Studio Code and Cursor
The VS Code ROS extension will attempt to detect and automatically configure the workspace for the appropriate ROS Distro.
The extension will automatically start when you open a catkin workspace.
The build system (e.g. catkin_make or catkin build) will automatically be confirmed from the hidden files associated with
each system.
Visit the Tutorials and Walkthroughs
Visit the Tutorials and Walkthroughs
The configuration options for the ROS extension enable customization and setup according to your specific needs. Refer to the ROS Launch Configuration options for detailed descriptions of available settings.
The Launch Debugging feature allows users to debug ROS nodes that are initiated by a launch file.
For more detailed instructions and options, refer to our debugging documentation.
If you encounter any issues with this extension, the following resources are provided:
Bugs and feature requests are handled through Github Issues in the Repository. If you find that you are hitting the same issue as someone else, please give a 👍 or comment on an existing issue. Please provide as much details as possible, including an isolated reproduction of the issue or a pointer to an online repository.
Github Discussions are provided for community driven general guidance, walkthroughs, or support.
If you find this extension useful, please consider sponsoring Ranch Hand Robotics to help support the development of this extension and other open source projects.
Contributions are always welcome! Please see our contributing guide for more details!
A big Thank you! to everyone that have helped make this extension better!
- Andrew Short (@ajshort), original author
- James Giller (@JamesGiller)
- PickNikRobotics (@PickNikRobotics) for code formatting