tools#

Gazebo Tools: Entrypoint to Gazebo’s command line interface

Maintainer: caguero AT openrobotics DOT org

GitHub open issues GitHub open pull requests Discourse topics Hex.pm

Build

Status

Test coverage

codecov

Ubuntu Jammy

Build Status

Homebrew

Build Status

Windows

Build Status

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.1 (2024-03-28)

  1. Use relative install path for gz bash completion data

  2. gz.in: sort list of commands alphabetically

  3. Add project soversion information to backward library

  4. Remove shebang from shell completion files

  5. Update CI badges in README

  6. Support building with gz-cmake3 or gz-cmake4

  7. Fix conda link and dependencies

  8. Fix installation link

  9. Infrastructure

  10. Rename COPYING to LICENSE

Gazebo Tools 2.0.0 (2022-09-22)

  1. Remove ign CLI from version 2

  2. Finale: CMake var followups, docs, and paths

  3. ign -> gz Partial Docs Migration and Project Name Followups : gz-tools

  4. Rename CMake project to gz

  5. Use gz-cmake

  6. ign -> gz CLI Migration : gz-tools

  7. Standardize config macros

  8. Migrate ignition:: to gz::

  9. Remove Bionic from future releases (Garden+)

  10. Update codeowners

  11. [master] Workflow updates

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

  2. Infrastructure & CI

  3. Remove unused config.hh.in

  4. Bump CMake to 2.8.12

  5. Fix .dll installation directory on Windows

  6. Permit to invoke ign command in Windows

Gazebo Tools 1.4.1 (2021-10-27)

  1. Fix Windows colcon build

  2. Add flag to get standard-compliant exception handling

  3. Fix use of Backward on macOS

Gazebo Tools 1.4.0 (2021-10-15)

  1. Improve backtrace generation using Backward

Gazebo Tools 1.3.0 (2021-09-27)

  1. Remove all death CMake code related to test.

  2. Remove build dependency on ruby (not needed)

  3. Remove unused cmake code related to compilations (CFlags, BUILD_TYPE, etc.)

  4. Add Windows support

  5. Sort versions correctly.

  6. Infrastructure

Gazebo Tools 1.2.0 (2021-04-26)

  1. Relax version verification

Gazebo Tools 1.1.0 (2021-03-30)

  1. Use ; as GZ_CONFIG_PATH delimiter on windows

  2. Clean up gz-tools.pc file

  3. Fix cmake warning and error mesage types

  4. Infrastructure updates

  5. Do not overwrite default linker flags so that LDFLAGS environment variable is considered

  6. Add Windows installation

  7. Fix: Use PACKAGE_PREFIX_DIR to ensure relocatable CMake install for conan

  8. Add ruby style checker

  9. When using help, append –help to specific command

  10. Added –commands

  11. Set the process title to something nice

Gazebo Tools 1.0.0 (2019-12-09)

Gazebo Tools 0.2.0

  1. Accepting multiple paths in GZ_CONFIG_PATH.

  2. Backport changes from default branch (pipeline, Code of Conduct, etc.)

  3. Link to main contributing guide.

  4. Exit with success code 0 for help command.

Gazebo Tools 0.1.0