ferroclass 0.12.0

Hierarchical inventory management tool (reclass compatible)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

// SPDX-FileCopyrightText: 2026 Michael Jansen <ferroclass@michael-jansen.biz>
// SPDX-License-Identifier: MPL-2.0

//! CLI argument definitions for the reclass binary.

use clap::{Args, Parser};
use serde::{Deserialize, Serialize};

use crate::inventory::options::{OutputFormat, ParameterKeyStyle, StorageType};

#[derive(Args, Debug, Default, Serialize, Deserialize)]
#[group(multiple = false, required = true)]
pub struct CommandOptions {
    /// output the entire inventory
    #[arg(short, long)]
    pub inventory: bool,

    /// output information for a specific node
    #[arg(short, long, value_name = "NODENAME")]
    pub nodeinfo: Option<String>,
}

#[derive(Args, Debug, Default, Deserialize, Serialize)]
#[group()]
pub struct OutputOptions {
    /// output format (YAML or JSON)
    #[arg(value_enum, short, long)]
    pub output: Option<OutputFormat>,

    /// pretty-print output (indented, newlines)
    #[arg(short = 'y', long)]
    pub pretty_print: bool,

    /// sort keys alphabetically in output
    #[arg(long)]
    pub output_sorted: bool,

    /// suppress YAML anchors/aliases in output (always enabled in this implementation; accepted for compatibility)
    #[arg(short = 'r', long)]
    pub no_refs: bool,

    /// group multiple resolve errors and report them together instead of failing on the first error
    #[arg(short = '0', long = "multiple-errors", conflicts_with = "single_error")]
    pub group_errors: bool,

    /// report only the first resolve error instead of grouping all errors
    #[arg(short = '1', long = "single-error", conflicts_with = "group_errors")]
    pub single_error: bool,
}

#[derive(Args, Debug, Default, Deserialize, Serialize)]
#[group()]
pub struct StorageOptions {
    /// the type of storage backend to use
    #[arg(value_enum, short, long)]
    pub storage_type: Option<StorageType>,

    /// the base URI to prepend to nodes and classes
    #[arg(short = 'b', long)]
    pub inventory_base_uri: Option<String>,

    /// the URI to the node storage
    #[arg(short = 'u', long)]
    pub nodes_uri: Option<String>,

    /// the URI to the class storage
    #[arg(short = 'c', long)]
    pub classes_uri: Option<String>,

    /// parameter key validation style
    #[arg(value_enum, short, long)]
    pub parameter_key_style: Option<ParameterKeyStyle>,

    /// compose node names from subdirectory paths
    #[arg(short = 'a', long)]
    pub compose_node_name: bool,

    /// ignore classes that are not found instead of raising an error
    #[arg(short = 'z', long)]
    pub ignore_class_notfound: bool,

    /// regexp pattern for class names to ignore when not found (can be specified multiple times)
    #[arg(short = 'x', long, value_name = "PATTERN")]
    pub ignore_class_notfound_regexp: Option<Vec<String>>,
}

#[derive(Parser, Debug, Default, Serialize, Deserialize)]
#[serde(default)]
#[command(
    name = "ferroclass",
    bin_name = "ferroclass",
    version,
    about = "Hierarchical inventory management tool (reclass compatible)",
    after_help = "Use --inventory to output the entire inventory as YAML or JSON.\n\
                  Use --nodeinfo NODENAME to output merged data for a specific node.\n\
                  \n\
                  Configuration is read from reclass-config.yml in the current\n\
                  directory or its parents. CLI options override config file values."
)]
pub struct Arguments {
    /// enable verbose logging
    #[arg(short, long)]
    pub verbose: bool,

    #[command(flatten, next_help_heading = "Database options")]
    pub storage_options: StorageOptions,

    #[command(flatten, next_help_heading = "Output options")]
    pub output_options: OutputOptions,

    #[command(flatten, next_help_heading = "Modes")]
    pub command_options: CommandOptions,
}