iceoryx2-cli

Crates.ioiceoryx2-cli
lib.rsiceoryx2-cli
version
sourcesrc
created_at2024-09-28 16:26:52.990702
updated_at2024-12-23 17:28:55.303285
descriptionCLI tools for iceoryx2
homepagehttps://iceoryx.io
repositoryhttps://github.com/eclipse-iceoryx/iceoryx2
max_upload_size
id1390228
Cargo.toml error:TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include`
size0
Christian Eltzschig (elfenpiff)

documentation

README

iceoryx2-cli

CLI tooling for interacting with iceoryx2 systems.

Installation

Install via cargo:

cargo install iceoryx2-cli

Usage

The entrypoint to the CLI is iox2:

$ iox2 --help
The command-line interface entrypoint to iceoryx2.

Usage: iox2 [OPTIONS] [COMMAND]

Options:
  -l, --list     List all installed external commands
  -p, --paths    Display paths that will be checked for external commands
  -h, --help     Print help
  -V, --version  Print version

Commands:
  ...            See external installed commands with --list

Sub-commands are separate binaries (prefixed with iox2-) which can be discovered by the entrypoint:

$ iox2 --list
Discovered Commands:
  node
  service

Sub-commands can be run using their discovered name:

$ iox2 service --help
Query information about iceoryx2 services

Usage: iox2 service [OPTIONS] [COMMAND]

Options:
  -f, --format <FORMAT>  [default: RON] [possible values: RON, JSON, YAML]
  -h, --help             Print help
  -V, --version          Print version

Commands:
  list     List all services
  details  Show service details

$ iox2 node --help
Query information about iceoryx2 nodes

Usage: iox2 node [OPTIONS] [COMMAND]

Options:
  -f, --format <FORMAT>  [default: RON] [possible values: RON, JSON, YAML]
  -h, --help             Print help
  -V, --version          Print version

Commands:
  list     List all nodes
  details  Show node details

Extending

  1. The CLI can be augmented with your own custom tool by developing binaries with a name prefixed by iox2- and placing it on the PATH to be discovered by iox2
  2. Depend on iceoryx2-cli for some helpers to help with implementation:
    1. An output module defining the various output structures used by this crate
    2. A Filter trait for filtering data retrieved from iceoryx2
    3. A Format enum providing functionality for outputting in different formats
Commit count: 1976

cargo fmt