Unofficial CLI tool for installing ROS 2 and setting up a workspace
Project description
ros2-installer
A CLI tool to install ROS 2 distributions easily from the official repositories.
Disclaimer
This tool installs ROS 2 from the official repositories but is not an official ROS release. Use at your own risk.
The owner of this project, platform, or service shall not be held liable for any loss, damage, or corruption of data, whether caused by system failures, user errors, or any other unforeseen circumstances. By using this service, you acknowledge and agree that you are solely responsible for backing up and protecting your data.
Features
- Interactive ROS 2 distro selection (e.g., humble, iron)
- Automatic locale setup
- Workspace creation
- Optionally appends sourcing commands to
.bashrc - Headless mode (non-interactive) with all options specified via CLI arguments
- Works on Ubuntu 22.04+
Installation
pip install ros2-installer
Usage
Interactive Mode
Just run:
ros2-installer
You will be prompted step by step to:
- Choose the ROS 2 distro (humble or iron)
- Confirm installation
- Specify workspace name and location
- Choose whether to auto-source in
.bashrc
Headless Mode
If you want to run everything non-interactively (e.g., in CI pipelines or Docker), you can pass all required arguments:
ros2-installer \
--distro humble \
--workspace ~/ros2_ws \
--yes \
--auto-source
Arguments:
| Argument | Description |
|---|---|
--distro |
ROS 2 distro to install (humble, iron) |
--workspace |
Path to create the workspace |
--yes |
Automatically confirm all prompts |
--auto-source |
Automatically append sourcing commands to .bashrc |
Example:
ros2-installer --distro humble --workspace ~/ros2_ws --yes --auto-source
Bug-Report
- Raise an issue in the github repository
License
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ros2_installer-0.1.3.tar.gz.
File metadata
- Download URL: ros2_installer-0.1.3.tar.gz
- Upload date:
- Size: 5.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
85f0af4c4e2a926cdbc6b08fcc7ea8991923eec0d064182ddff10a723df8b44f
|
|
| MD5 |
8e0939e9ea356155ba6dab3e8377abc6
|
|
| BLAKE2b-256 |
a9aa21f24fa20327a45d7823dc0fc2f2aa94e3e242c9e149bd62a32226fa772b
|
File details
Details for the file ros2_installer-0.1.3-py3-none-any.whl.
File metadata
- Download URL: ros2_installer-0.1.3-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f239d0c804db0e529ea856a77b8567509ea78a16a4e7f92d271bdbddd4d34091
|
|
| MD5 |
96092949cf0965fc48138f0e6609e0a6
|
|
| BLAKE2b-256 |
3a05643ada6275ae32ca9ad083290d954439de7977b952fa607bffd71754f43d
|