schemaui-cli 0.4.2

CLI wrapper for schemaui, rendering JSON Schemas as TUIs
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

use std::path::PathBuf;

use clap::{ArgAction, Args, Parser, Subcommand};

#[cfg(feature = "web")]
use std::net::IpAddr;

#[derive(Debug, Parser)]
#[command(
    name = "schemaui",
    version,
    about = "Render JSON Schemas as interactive TUIs or Web UIs"
)]
pub struct Cli {
    #[command(flatten)]
    pub common: CommonArgs,

    #[command(subcommand)]
    pub command: Option<Commands>,
}

#[derive(Debug, Subcommand)]
pub enum Commands {
    /// Launch the interactive terminal UI
    Tui(TuiCommand),

    #[cfg(feature = "web")]
    /// Launch the interactive web UI instead of the terminal UI
    Web(WebCommand),

    #[cfg(feature = "web")]
    /// Precompute Web session snapshots instead of launching the UI
    WebSnapshot(WebSnapshotCommand),

    /// Precompute TUI FormSchema/LayoutNavModel modules instead of launching the UI
    TuiSnapshot(TuiSnapshotCommand),
}

#[derive(Debug, Args, Clone)]
pub struct TuiCommand {
    #[command(flatten)]
    pub common: CommonArgs,
}

#[cfg(feature = "web")]
#[derive(Debug, Args, Clone)]
pub struct WebCommand {
    #[command(flatten)]
    pub common: CommonArgs,

    /// Bind address for the temporary HTTP server
    #[rustfmt::skip]
    #[arg(alias = "bind", alias = "listen")]
    #[arg( short = 'l', long = "host", value_name = "IP", default_value = "127.0.0.1" )]
    pub host: IpAddr,

    /// Bind port for the temporary HTTP server (0 picks a random free port)
    #[arg(short = 'p', long = "port", value_name = "PORT", default_value_t = 0)]
    pub port: u16,
}

#[cfg(feature = "web")]
#[derive(Debug, Args, Clone)]
pub struct WebSnapshotCommand {
    #[command(flatten)]
    pub common: CommonArgs,

    /// Output directory for generated Web snapshots (JSON + TS)
    #[arg(long = "out-dir", value_name = "DIR", default_value = "web_snapshots")]
    pub out_dir: PathBuf,

    /// Name of the exported constant in the generated TS module
    #[arg(
        long = "ts-export",
        value_name = "NAME",
        default_value = "SessionSnapshot"
    )]
    pub ts_export: String,
}

#[derive(Debug, Args, Clone)]
pub struct TuiSnapshotCommand {
    #[command(flatten)]
    pub common: CommonArgs,

    /// Output directory for generated TUI artifact modules (Rust source)
    #[arg(long = "out-dir", value_name = "DIR", default_value = "tui_artifacts")]
    pub out_dir: PathBuf,

    /// Name of the generated TuiArtifacts constructor function
    #[arg(long = "tui-fn", value_name = "NAME", default_value = "tui_artifacts")]
    pub tui_fn: String,

    /// Name of the generated FormSchema constructor function
    #[arg(
        long = "form-fn",
        value_name = "NAME",
        default_value = "tui_form_schema"
    )]
    pub form_fn: String,

    /// Name of the generated LayoutNavModel constructor function
    #[arg(
        long = "layout-fn",
        value_name = "NAME",
        default_value = "tui_layout_nav"
    )]
    pub layout_fn: String,
}

#[derive(Debug, Args, Clone)]
pub struct CommonArgs {
    /// Schema spec: file path, inline payload, or "-" for stdin
    #[arg(short = 's', long = "schema", value_name = "SPEC")]
    pub schema: Option<String>,

    /// Config spec: file path, inline payload, or "-" for stdin
    #[arg(short = 'c', long = "config", alias = "data", value_name = "SPEC")]
    pub config: Option<String>,

    /// Title shown at the top of the UI
    #[arg(long = "title", value_name = "TEXT")]
    pub title: Option<String>,

    /// Output destinations ("-" writes to stdout). Accepts multiple values per flag use.
    #[arg(short = 'o', long = "output", value_name = "DEST", num_args = 1.., action = ArgAction::Append)]
    pub outputs: Vec<String>,

    /// Override the default temp file location (only used when no other destinations are set)
    #[arg(long = "temp-file", value_name = "PATH")]
    pub temp_file: Option<PathBuf>,

    /// Disable writing to the default temp file when no destinations are provided
    #[arg(long = "no-temp-file")]
    pub no_temp_file: bool,

    /// Emit compact JSON/TOML rather than pretty formatting
    #[arg(long = "no-pretty")]
    pub no_pretty: bool,

    /// Overwrite output files even if they already exist
    #[arg(short = 'f', long = "force", short_alias = 'y', alias = "yes")]
    pub force: bool,
}