Skip to content

ros2/ros2cli

Folders and files

NameName
Last commit message
Last commit date
Nov 27, 2024
Jan 21, 2025
Jan 2, 2025
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 28, 2024
Dec 20, 2024
Jan 21, 2025
Jan 24, 2025
Jun 14, 2017
Mar 20, 2019
Jun 6, 2017
Apr 16, 2024
Nov 3, 2023

Repository files navigation

ros2cli

This repository contains the source code for ROS 2 command line interface tools included with a standard install of any ROS 2 distro.

Usage

Run ros2 --help to see all available commands.

Run ros2 <command> --help for more information on individual command usage.

Run ros2 <command> <verb> --help for even more usage information on a specific command's verbs.

Read Introspection with command line tools for more information and an example.

Cheat Sheet

This cheat sheet provides examples for commands and their verbs (some of which rely on the ROS 2 demos package).

Add New Verbs

You can use Python entry points to create new commands and verbs for the CLI.

Here's an example.

And here's an example for how to add a command.

Background

You can find a historical discussion on this subject on Discourse.