Skip to content

Commit 8e06796

Browse files
authored
Create README (#294)
* Create README issue #157 Would appreciate review for correct use of language, relevance of links, content, etc. Signed-off-by: maryaB-osr <[email protected]> * Changed command/verb usage and included add command tutorial Signed-off-by: Marya <[email protected]>
1 parent ef61333 commit 8e06796

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# ros2cli
2+
3+
This repository contains the source code for ROS 2 command line interface tools included with a standard install of any ROS 2 distro.
4+
5+
## Usage
6+
7+
Run `ros2 --help` to see all available commands.
8+
9+
Run `ros2 <command> --help` for more information on individual command usage.
10+
11+
Run `ros2 <command> <verb> --help` for even more usage information on a specific command's verbs.
12+
13+
Read [Introspection with command line tools](https://index.ros.org/doc/ros2/Tutorials/Introspection-with-command-line-tools/) on ROS Index for more information and an example.
14+
15+
### Cheat Sheet
16+
17+
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)).
18+
19+
## Add New Verbs
20+
21+
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.
22+
[Here's an example](https://github.com/ros2/ros2cli/pull/273/files).
23+
And [here's and example](https://github.com/artivis/ros2hellocli) for how to add a command.
24+
25+
## Background
26+
27+
You can find a [historical discussion](https://discourse.ros.org/t/ros-graph-information-tools-implementation-discussion/674/34) on this subject on Discourse.

0 commit comments

Comments
 (0)