ROS Index
Repository Summary
| Description | Powerful ROS 2 Package Generator |
| Checkout URI | https://github.com/ika-rwth-aachen/ros2-pkg-create.git |
| VCS Type | git |
| VCS Version | main |
| Last Updated | 2025-06-07 |
| Dev Status | UNKNOWN |
| Released | UNRELEASED |
| Tags | ros ros2 |
| Contributing |
Help Wanted (-)
Good First Issues (-) Pull Requests to Review (-) |
Packages
| Name | Version |
|---|---|
| ros2_cpp_all_pkg | 0.0.0 |
| ros2_cpp_all_pkg_interfaces | 0.0.0 |
| ros2_cpp_component_pkg | 0.0.0 |
| ros2_cpp_lifecycle_pkg | 0.0.0 |
| ros2_cpp_pkg | 0.0.0 |
| ros2_interfaces_pkg | 0.0.0 |
| ros2_python_all_pkg | 0.0.0 |
| ros2_python_all_pkg_interfaces | 0.0.0 |
| ros2_python_pkg | 0.0.0 |
README
ros2-pkg-create – Powerful ROS 2 Package Generator
ros2-pkg-create is an interactive CLI tool for quickly generating ROS 2 packages from basic pub/sub nodes to complex lifecycle components. It is meant to replace the official ros2 pkg create command.
[!IMPORTANT]
This repository is open-sourced and maintained by the Institute for Automotive Engineering (ika) at RWTH Aachen University.
ROS is the backbone of many research topics within our Vehicle Intelligence & Automated Driving domain.
If you would like to learn more about how we can support your advanced driver assistance and automated driving efforts, feel free to reach out to us!
:email: opensource@ika.rwth-aachen.de
Quick Demo
pip install ros2-pkg-create
ros2-pkg-create --template ros2_cpp_pkg .
Installation
pip install ros2-pkg-create
# (optional) bash auto-completion
activate-global-python-argcomplete
eval "$(register-python-argcomplete ros2-pkg-create)"
[!WARNING]
Outside of a virtual environment, pip may default to a user-site installation of executables to~/.local/bin, which may not be present in your shell’sPATH. If runningros2-pkg-createerrors withros2-pkg-create: command not found, add the directory to your path. (More information)echo "export PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc source ~/.bashrc
Templates & Features
ros2-pkg-create provides multiple templates, each covering a different questionnaire for generating all the components you need. See below for the list of supported features and questionnarie options. Note that all options can also be passed directly to the command, bypassing the interactive questionnaire (see Usage).
C++ Package (--template ros2_cpp_pkg)
Supported Features: publisher, subscriber, parameter loading, launch file, service server, action server, timer callback, component, lifecycle node, docker-ros
Questionnaire
- Package name - Description - Maintainer | Maintainer email - Author | Author email - License - Node name - Class name of node - Make it a component? - Make it a lifecycle node? - Add a launch file? | Type of launch file - Add parameter loading? - Add a subscriber? - Add a publisher? - Add a service server? - Add an action server? - Add a timer callback? - Add the docker-ros CI integration?Python Package (--template ros2_python_pkg)
Supported Features: publisher, subscriber, parameter loading, launch file, service server, action server, timer callback, docker-ros