iceoryx2-cli 0.9.1

CLI tools for iceoryx2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

// Copyright (c) 2024 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available under the
// terms of the Apache Software License 2.0 which is available at
// https://www.apache.org/licenses/LICENSE-2.0, or the MIT license
// which is available at https://opensource.org/licenses/MIT.
//
// SPDX-License-Identifier: Apache-2.0 OR MIT

use clap::Parser;

use iceoryx2_cli::help_template;

#[derive(Parser, Debug)]
#[command(
    name = "iox2",
    bin_name = "iox2",
    about = "The command-line interface entrypoint to iceoryx2.",
    long_about = None,
    version = env!("CARGO_PKG_VERSION"),
    disable_help_subcommand = true,
    arg_required_else_help = false,
    help_template = help_template().with_external_command_hint().build(),
)]
pub struct Cli {
    #[arg(short, long, help = "List all installed external commands")]
    pub list: bool,

    #[arg(
        short,
        long,
        help = "Display paths that will be checked for external commands"
    )]
    pub paths: bool,

    #[arg(
        hide = true,
        required = false,
        trailing_var_arg = true,
        allow_hyphen_values = true
    )]
    pub external_command: Vec<String>,
}