meka 0.2.6

meka analyzer
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

//! Meka args and CLI handling

use clap::{ArgAction, Parser, Subcommand};
use std::path::PathBuf;

use crate::utils::MEKA_FILE;

/// meka args
#[derive(Parser, Debug)]
#[command(version, about, long_about = None,
    subcommand_required = true,
    arg_required_else_help = true,
)]
pub struct MekaArgs {
    /// Debug level (repeat -d for more verbosity)
    #[arg(short = 'd', visible_short_alias='v',  action = ArgAction::Count)]
    pub debug: u8,

    /// Subcommand
    #[command(subcommand)]
    pub command: Commands,
}

/// meka subcommands
#[derive(Subcommand, Debug)]
pub enum Commands {
    /// Run the tool and optionally write results to a file
    #[command(visible_alias = "run")]
    Record(RunArgs),

    /// Perform analysis
    #[command(visible_alias = "analyse")]
    Analyze(AnalyzeArgs),
}

/// Arguments for the "run" command
#[derive(Debug, Parser)]
pub struct RunArgs {
    /// global debug flag
    #[arg(global = true, short = 'd', visible_short_alias='v', action = ArgAction::Count)]
    pub debug: u8,

    /// Alias for -o=-
    /// Output on standard output
    #[arg(long = "json", action = ArgAction::SetTrue)]
    pub json_output: bool,

    /// Capture environ
    #[arg(long, action = ArgAction::SetTrue)]
    pub capture_environ: bool,

    /// Capture status
    #[arg(long, action = ArgAction::SetTrue)]
    pub capture_status: bool,

    /// Write file at each insert
    #[arg(long, action = ArgAction::SetTrue)]
    pub write_on_insert: bool,

    /// Relative Pid
    #[arg(long, action = ArgAction::SetTrue)]
    pub relative_pid: bool,

    /// Change the cwd
    #[arg(long, alias = "pwd")]
    pub cwd: Option<PathBuf>,

    /// Override the PATH environment variable for command lookup
    #[arg(long = "path", value_name = "PATH")]
    pub path_var: Option<Vec<PathBuf>>,

    /// Output file (e.g. file.json)
    #[arg(
        short = 'o',
        long = "output",
        value_name = "RECORDING_FILE",
        default_value = MEKA_FILE
    )]
    pub output_file: String,

    /// Command to test
    #[arg(value_name = "COMMAND LINE", required = true)]
    pub inputs: Vec<String>,

    /// Wrap args in shell
    #[arg(long, action = ArgAction::SetTrue)]
    pub wrap_shell: bool,
}

/// Arguments for the "analyze" command
#[derive(Debug, Parser)]
pub struct AnalyzeArgs {
    /// global debug flag
    #[arg(global = true, short = 'd', visible_short_alias='v', action = ArgAction::Count)]
    pub debug: u8,

    /// Minimum command size to print
    #[arg(long, default_value_t = 50)]
    pub min_cmd_size: usize,

    /// Optional name of file
    #[arg(value_name = "RECORDING_FILE", default_value = MEKA_FILE)]
    pub input_file: String,
}