Quickstart

Installation

Make sure you have docker, python 3.11, venv, and pip installed.

python3 -m venv ~/.devc-venv && source ~/.devc-venv/bin/activate &&
pip install git+https://github.com/Rosiris-Open-Source/devcontainer-tool.git

Usage

You can always see available commands by running:

devc -h
or
devc <command> -h e.g. devc dev-json -h

Create a Dockerfile:

Create a Dockerfile (optional):

devc dockerfile <dockerfile_plugin>

ROS2 Example:

For example, to create a Dockerfile with Ubuntu 24.04 and ROS2 Rolling:

devc dockerfile ros2-desktop-full

Create a devcontainer.json:

Create a devcontainer.json using a local Dockerfile located in .docker/Dockerfile:

devc dev-json <dev-json_plugin> --name "test_project"

If you want to use an existing image instead:

devc dev-json <dev-json_plugin> --name "test_project" --image="<image_name>"

ROS2 Example:

For example, to create a Dockerfile with Ubuntu 24.04 and ROS2 Rolling:

devc dev-json ros2-desktop-full --name "ros2_rolling_project" --nvidia --ssh=mount

Note

• The folder in which the .devcontainer/devcontainer.json is in, is mounted as workspace into the container.

See Plugin System for how to create your own dev-json plugins and extensions.