provenance-cli 0.2.1

Command-line interface for Provenance requirements traceability
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use crate::output::OutputFormat;
use camino::Utf8PathBuf;
use clap::{Args, Subcommand};

/// What every structured query primitive needs besides its stdin request.
#[derive(Args)]
pub struct QueryArgs {
    #[arg(long)]
    pub repo: Option<Utf8PathBuf>,
    #[arg(long, default_value = "default")]
    pub scope: String,
    #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
    pub format: OutputFormat,
}

#[derive(Subcommand)]
pub enum SdkCommand {
    /// Check one unfinished Requirement or Rule statement from stdin.
    CheckStatement {
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
    /// Report engine compatibility and the resolved project root.
    Info {
        #[arg(long)]
        repo: Option<Utf8PathBuf>,
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
    /// Preview one desired-state reconciliation without writing it.
    Plan {
        #[arg(long)]
        repo: Option<Utf8PathBuf>,
        #[arg(long, default_value = "default")]
        scope: String,
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
    /// Reconcile one desired-state document read from stdin.
    Apply {
        #[arg(long)]
        repo: Option<Utf8PathBuf>,
        #[arg(long, default_value = "default")]
        scope: String,
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
    /// Start one callback-backed verification run described on stdin.
    BeginVerification {
        #[arg(long)]
        repo: Option<Utf8PathBuf>,
        #[arg(long, default_value = "default")]
        scope: String,
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
    /// Finish one callback-backed verification run described on stdin.
    CompleteVerification {
        #[arg(long)]
        repo: Option<Utf8PathBuf>,
        #[arg(long, default_value = "default")]
        scope: String,
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
    /// List cached callback-backed verification evidence.
    VerificationRuns {
        #[arg(long)]
        repo: Option<Utf8PathBuf>,
        #[arg(long, default_value = "default")]
        scope: String,
        #[arg(long)]
        rule: Option<String>,
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
    /// Read one canonical record named by a JSON request on stdin.
    Get {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// Find canonical records whose text contains a phrase.
    Search {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// Read the canonical records one edge away from a record.
    Neighbors {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// Walk outward from a record for a bounded number of hops.
    Trace {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// Read the Rules a record reaches and the code standing behind them.
    Impact {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// Read the bindings, runs, review, and stale report for one Rule.
    Evidence {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// Read which evidence sites a commit range disturbed.
    Stale {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// Read the Rules bound to one code site.
    ResolveSymbol {
        #[command(flatten)]
        query: QueryArgs,
    },
    /// List durable typed verification relationships.
    VerificationBindings {
        #[arg(long)]
        repo: Option<Utf8PathBuf>,
        #[arg(long, default_value = "default")]
        scope: String,
        #[arg(long)]
        rule: Option<String>,
        #[arg(long, value_enum, default_value_t = OutputFormat::Json)]
        format: OutputFormat,
    },
}