Gazebo Tools: Entrypoint to Gazebo’s command line interface

Maintainer: caguero AT honurobotics DOT com

Build	Status
Test coverage
Ubuntu Jammy
Homebrew
Windows

Gazebo Tools provide the gz command line tool that accepts multiple subcommands. Each subcommand is implemented in a plugin that belongs to a specific Gazebo project. For example, all the commands that start with gz topic ... are implemented by the Gazebo Transport library.

Table of Contents

Features

Install

Contributing

Code of Conduct

Versioning

License

Features

Gazebo Tools provides the gz CLI for the entire Gazebo project.

Install

See the installation tutorial.

Contributing

Please see the contribution guide.

Code of Conduct

Please see CODE_OF_CONDUCT.md.

Versioning

This library uses Semantic Versioning. Additionally, this library is part of the Gazebo project which periodically releases a versioned set of compatible and complimentary libraries. See the Gazebo website for version and release information.

License

This library is licensed under Apache 2.0. See also the LICENSE file.

Gazebo Tools 2.x

Gazebo Tools 2.X.X (20XX-XX-XX)

Gazebo Tools 2.0.2 (2025-01-30)

1. Add colcon.pkg with gz-cmake4 dependency
   • Pull request #142
2. Fix dll search paths for Ruby on Windows
   • Pull request #140
3. Add package.xml
   • Pull request #136

Gazebo Tools 2.0.1 (2024-03-28)

1. Use relative install path for gz bash completion data
   • Pull request #137
2. gz.in: sort list of commands alphabetically
   • Pull request #134
3. Add project soversion information to backward library
   • Pull request #133
4. Remove shebang from shell completion files
   • Pull request #132
5. Update CI badges in README
   • Pull request #131
6. Support building with gz-cmake3 or gz-cmake4
   • Pull request #128
7. Fix conda link and dependencies
   • Pull request #126
8. Fix installation link
   • Pull request #124
9. Infrastructure
   • Pull request #118
   • Pull request #121
   • Pull request #123
   • Pull request #130
10. Rename COPYING to LICENSE
    • Pull request #117

Gazebo Tools 2.0.0 (2022-09-22)

1. Remove ign CLI from version 2
   • Pull request #109
2. Finale: CMake var followups, docs, and paths
   • Pull request #99
3. ign -> gz Partial Docs Migration and Project Name Followups : gz-tools
   • Pull request #98
4. Rename CMake project to gz
   • Pull request #93
5. Use gz-cmake
   • Pull request #96
6. ign -> gz CLI Migration : gz-tools
   • Pull request #94
7. Standardize config macros
   • Pull request #90
8. Migrate ignition:: to gz::
   • Pull request #89
9. Remove Bionic from future releases (Garden+)
   • Pull request #78
10. Update codeowners
    • Pull request #27
11. [master] Workflow updates
    • Pull request #18

Gazebo Tools 1.x

Gazebo Tools 1.X.X (20XX-XX-XX)

Gazebo Tools 1.5.0 (2022-08-12)

1. Bash completion for subcommand names and flags
   • Pull request #77
   • Pull request #86
   • Pull request #87
   • Pull request #104
   • Pull request #106
2. Infrastructure & CI
   • Pull request #100
   • Pull request #80
   • Pull request #75
3. Remove unused config.hh.in
   • Pull request #91
4. Bump CMake to 2.8.12
   • Pull request #85
5. Fix .dll installation directory on Windows
   • Pull request #74
6. Permit to invoke ign command in Windows
   • Pull request #73

Gazebo Tools 1.4.1 (2021-10-27)

1. Fix Windows colcon build
   • Pull request #65
2. Add flag to get standard-compliant exception handling
   • Pull request #68
3. Fix use of Backward on macOS
   • Pull request #67

Gazebo Tools 1.4.0 (2021-10-15)

1. Improve backtrace generation using Backward
   • Pull request #63

Gazebo Tools 1.3.0 (2021-09-27)

1. Remove all death CMake code related to test.
   • Pull request #54
2. Remove build dependency on ruby (not needed)
   • Pull request #53
3. Remove unused cmake code related to compilations (CFlags, BUILD_TYPE, etc.)
   • Pull request #55
   • Pull request #56
4. Add Windows support
   • Pull request #57
5. Sort versions correctly.
   • Pull request #50
6. Infrastructure
   • Pull request #59
   • Pull request #58

Gazebo Tools 1.2.0 (2021-04-26)

1. Relax version verification
   • Pull request #44

Gazebo Tools 1.1.0 (2021-03-30)

1. Use ; as GZ_CONFIG_PATH delimiter on windows
   • Pull request #45
2. Clean up gz-tools.pc file
   • Pull request #40
3. Fix cmake warning and error message types
   • Pull request #41
4. Infrastructure updates
   • Pull request #42
   • Pull request #38
   • Pull request #37
   • Pull request #29
   • Pull request #22
   • Pull request #17
   • Pull request #11
   • Pull request #13
5. Do not overwrite default linker flags so that LDFLAGS environment variable is considered
   • Pull request #35
6. Add Windows installation
   • Pull request #34
7. Fix: Use PACKAGE_PREFIX_DIR to ensure relocatable CMake install for conan
   • Pull request #30
8. Add ruby style checker
   • Pull request #25
9. When using help, append –help to specific command
   • Pull request #15
10. Added –commands
    • BitBucket pull request 23
11. Set the process title to something nice
    • BitBucket pull request 22

Gazebo Tools 1.0.0 (2019-12-09)

Gazebo Tools 0.2.0

1. Accepting multiple paths in GZ_CONFIG_PATH.
   • BitBucket pull request 14
   • BitBucket pull request 13
2. Backport changes from default branch (pipeline, Code of Conduct, etc.)
   • BitBucket pull request 11
3. Link to main contributing guide.
   • BitBucket pull request 5
4. Exit with success code 0 for help command.
   • BitBucket pull request 4

Gazebo Tools 0.1.0