osp-cli 1.5.1

CLI and REPL for querying and managing OSP infrastructure data
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
114

fn row(value: Value) -> Row {
    value
        .as_object()
        .cloned()
        .expect("fixture should be an object")
}

fn run_rows_pipeline(rows: Vec<Row>, pipeline: &str) -> OutputResult {
    let parsed = parse_pipeline(&format!("fixture | {pipeline}")).expect("pipeline should parse");
    apply_output_pipeline(OutputResult::from_rows(rows), &parsed.stages)
        .expect("pipeline should succeed")
}

fn run_guide_pipeline(view: GuideView, pipeline: &str) -> OutputResult {
    let parsed = parse_pipeline(&format!("fixture | {pipeline}")).expect("pipeline should parse");
    apply_output_pipeline(view.to_output_result(), &parsed.stages).expect("pipeline should succeed")
}

fn sample_guide() -> GuideView {
    GuideView {
        usage: vec!["osp intro".to_string()],
        commands: sample_commands(),
        ..GuideView::default()
    }
}

fn sample_commands() -> Vec<GuideEntry> {
    vec![
        GuideEntry {
            name: "help".to_string(),
            short_help: "Show overview".to_string(),
            display_indent: None,
            display_gap: None,
        },
        GuideEntry {
            name: "config".to_string(),
            short_help: "Show config values".to_string(),
            display_indent: None,
            display_gap: None,
        },
        GuideEntry {
            name: "exit".to_string(),
            short_help: "Leave shell".to_string(),
            display_indent: None,
            display_gap: None,
        },
    ]
}

fn guide_with_sections() -> GuideView {
    GuideView {
        commands: vec![
            GuideEntry {
                name: "deploy".to_string(),
                short_help: "Deploy a VM".to_string(),
                ..Default::default()
            },
            GuideEntry {
                name: "list".to_string(),
                short_help: "List all VMs".to_string(),
                ..Default::default()
            },
            GuideEntry {
                name: "delete".to_string(),
                short_help: "Delete a VM".to_string(),
                ..Default::default()
            },
        ],
        sections: vec![
            GuideSection {
                title: "Actions".to_string(),
                kind: GuideSectionKind::Commands,
                paragraphs: vec![],
                entries: vec![
                    GuideEntry {
                        name: "start".to_string(),
                        short_help: "Start the VM".to_string(),
                        ..Default::default()
                    },
                    GuideEntry {
                        name: "stop".to_string(),
                        short_help: "Stop the VM".to_string(),
                        ..Default::default()
                    },
                    GuideEntry {
                        name: "restart".to_string(),
                        short_help: "Restart the VM".to_string(),
                        ..Default::default()
                    },
                ],
                data: None,
            },
            GuideSection {
                title: "Utilities".to_string(),
                kind: GuideSectionKind::Custom,
                paragraphs: vec![],
                entries: vec![
                    GuideEntry {
                        name: "version".to_string(),
                        short_help: "Show version info".to_string(),
                        ..Default::default()
                    },
                    GuideEntry {
                        name: "doctor".to_string(),
                        short_help: "Run diagnostics".to_string(),
                        ..Default::default()
                    },
                ],
                data: None,
            },
        ],
        ..GuideView::default()
    }
}