batman-robin 1.2.1

Rust library and CLI tool for interacting with the BATMAN-adv kernel module for mesh networking
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

use super::aggregation::cmd_aggregation;
use super::ap_isolation::cmd_ap_isolation;
use super::bridge_loop_avoidance::cmd_bridge_loop_avoidance;
use super::gateways::cmd_gateways;
use super::gw_mode::cmd_gw_mode;
use super::interface::cmd_interfaces;
use super::neighbors::cmd_neighbors;
use super::originators::cmd_originators;
use super::routing_algo::cmd_routing_algo;
use super::transglobal::cmd_transglobal;
use super::translocal::cmd_translocal;
use clap::{Arg, Command};

/// Builds the command-line interface (CLI) for `robctl`.
///
/// This function sets up the main CLI structure using `clap`, including global options
/// and all subcommands.
///
/// # Global Options
/// - `--meshif`, `-m` : Specify the batman-adv mesh interface to operate on (default: `bat0`).
/// - `--version`, `-v` : Print the `robctl` version and the batman-adv kernel module version (if loaded).
///
/// # Subcommands
/// - `neighbors` (`n`) : Display the neighbor table.
/// - `gateways` (`gwl`) : Display the list of gateways.
/// - `gw_mode` (`gw`) : Display or modify the gateway mode.
/// - `originators` (`o`) : Display the originator table.
/// - `translocal` (`tl`) : Display local translation table.
/// - `transglobal` (`tg`) : Display global translation table.
/// - `interface` (`if`) : Display or modify batman-adv interface settings.
/// - `ap_isolation` (`ap`) : Display or modify AP isolation setting.
/// - `aggregation` (`ag`) : Display or modify aggregation setting.
/// - `bridge_loop_avoidance` (`bl`) : Display or modify bridge loop avoidance setting.
/// - `routing_algo` (`ra`) : Display or modify the routing algorithm.
///
/// # Returns
/// A `clap::Command` ready to parse command-line arguments.
///
/// # Example
/// ```no_run
/// use batman_robin::cli::app::build_cli;
///
/// let cli = build_cli();
/// let matches = cli.get_matches();
/// ```
pub fn build_cli() -> Command {
    Command::new("robctl")
        //.subcommand_required(true)
        .arg_required_else_help(true)
        .about("Rust implementation of batctl, B.A.T.M.A.N. advanced control tool")
        .arg(
            Arg::new("meshif")
                .long("meshif")
                .short('m')
                .value_name("IFACE")
                .help("Batman-adv mesh interface to operate on (default: bat0)"),
        )
        .arg(
            Arg::new("version")
                .short('v')
                .long("version")
                .help("Print robctl version and batman-adv module version (if loaded)")
                .action(clap::ArgAction::SetTrue),
        )
        .subcommand(cmd_neighbors())
        .subcommand(cmd_gateways())
        .subcommand(cmd_gw_mode())
        .subcommand(cmd_originators())
        .subcommand(cmd_translocal())
        .subcommand(cmd_transglobal())
        .subcommand(cmd_interfaces())
        .subcommand(cmd_ap_isolation())
        .subcommand(cmd_aggregation())
        .subcommand(cmd_bridge_loop_avoidance())
        .subcommand(cmd_routing_algo())
}