https://github.com/ros2/ros2cli

ROS 2 command line interface tools
https://github.com/ros2/ros2cli

Last synced: 1 day ago
JSON representation

ROS 2 command line interface tools

• Host: GitHub
• URL: https://github.com/ros2/ros2cli
• Owner: ros2
• License: apache-2.0
• Created: 2017-06-06T22:13:14.000Z (over 7 years ago)
• Default Branch: rolling
• Last Pushed: 2024-09-17T17:22:37.000Z (about 2 months ago)
• Last Synced: 2024-09-17T21:50:36.156Z (about 2 months ago)
• Language: Python
• Homepage:
• Size: 2.66 MB
• Stars: 172
• Watchers: 29
• Forks: 161
• Open Issues: 103
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# 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  --help` for more information on individual command usage.

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

Read [Introspection with command line tools](https://docs.ros.org/en/rolling/Concepts/Basic/About-Command-Line-Tools.html) for more information and an example.

### Cheat Sheet

This [cheat sheet](https://github.com/artivis/ros2_cheats_sheet/blob/master/cli/cli_cheats_sheet.pdf) provides examples for commands and their verbs (some of which rely on the [ROS 2 demos package](https://github.com/ros2/demos)).

## Add New Verbs

You can use [Python entry points](https://setuptools.readthedocs.io/en/latest/pkg_resources.html#entry-points) to create new commands and verbs for the CLI.

[Here's an example](https://github.com/ros2/ros2cli/pull/273/files).

And [here's an example](https://github.com/artivis/ros2hellocli) for how to add a command.

## Background

You can find a [historical discussion](https://discourse.ros.org/t/ros-graph-information-tools-implementation-discussion/674/34) on this subject on Discourse.