iceoryx2-cli 0.9.0

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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

// 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 clap::Subcommand;

use iceoryx2_bb_elementary::package_version::PackageVersion;
use iceoryx2_cli::help_template;

#[derive(Parser)]
#[command(
    name = "iox2 config",
    bin_name = "iox2 config",
    about = "Query information about iceoryx2 configuration",
    long_about = None,
    version = PackageVersion::get_str(),
    disable_help_subcommand = true,
    arg_required_else_help = false,
    help_template = help_template().with_subcommands().build(),
)]
pub struct Cli {
    #[clap(subcommand)]
    pub action: Option<Action>,
}

#[derive(Subcommand)]
pub enum ShowSubcommand {
    #[clap(
        about = "Show the system-wide configuration",
        help_template = help_template().build()
    )]
    System,
    #[clap(
        about = "Show the currently loaded configuration",
        help_template = help_template().build()
    )]
    Current,
}

#[derive(Subcommand)]
pub enum GenerateSubcommand {
    #[clap(
        about = "Generate a local configuration file",
        help_template = help_template().build()
    )]
    Local,
    #[clap(
        about = "Generate a global configuration file",
        help_template = help_template().build()
    )]
    Global,
}

#[derive(Subcommand)]
pub enum Action {
    #[clap(
        about = "Show the currently used configuration",
        subcommand_required = true,
        arg_required_else_help = true,
        help_template = help_template().with_subcommands().build()
    )]
    Show {
        #[clap(subcommand)]
        config: ShowSubcommand,
    },
    #[clap(
        about = "Generate a default configuration file",
        subcommand_required = true,
        arg_required_else_help = true,
        help_template = help_template().with_subcommands().build()
    )]
    Generate {
        #[clap(subcommand)]
        config: GenerateSubcommand,
        #[clap(
            short,
            long,
            global = true,
            help = "Force overwrite existing configuration file"
        )]
        force: bool,
    },
    #[clap(
        about = "Explain the configuration parameters and their descriptions",
        help_template = help_template().build()
    )]
    Explain,
}