Skip to content

Commit

Permalink
Add reference to CLI in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
flferretti committed Dec 17, 2024
1 parent 4e76bca commit ce160d3
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,24 @@ print(urdf_string)

</details>

## Command Line Interface

ROD provides a command line interface (CLI) for processing robot description files. You can use the CLI to display file attributes or convert files between URDF and SDF formats.

### Usage

- Display the attributes of an SDF file:

```sh
rod --file /path/to/file.sdf --show
```

- Convert an SDF file to URDF:

```sh
rod --file /path/to/file.sdf -o /path/to/file.urdf
```

## Similar projects

- https://github.com/gazebosim/sdformat
Expand Down

0 comments on commit ce160d3

Please sign in to comment.