wyvern-cli 0.4.0

What You View, Engine Renders Natively — HTTP dialog CLI
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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
//! Host option flags (`--bind`, `--ui-root`, `--viewer`) and argv splitting.

use std::net::SocketAddr;
use std::path::{Path, PathBuf};

use wyvern_host::{HostOptions, ViewerMode};

use crate::error::{LoadError, UsageErrorKind};
use crate::extensions::{ExtensionRegistry, SHIPPED_EXTENSIONS_JSON};

/// Parsed CLI invocation: host options + remaining positional/stdin args.
#[derive(Debug, Clone)]
pub struct CliArgs {
    /// Options passed to [`wyvern_host::run`] / [`wyvern_host::begin`].
    pub host: HostOptions,
    /// Non-flag argv entries (JSON / file path).
    pub positionals: Vec<String>,
    /// `--workflow-dry-run` — append `--dry-run` to workflow pre/post argv.
    ///
    /// Never a [`HostOptions`] field (ADR-0023).
    pub workflow_dry_run: bool,
}

/// Split argv into host flags and positionals.
///
/// Product default (c.15+): omitted `--viewer` → [`ViewerMode::Embedded`].
/// `WYVERN_VIEWER` overrides when set. Host-only flags (`--bind`, `--ui-root`,
/// `--viewer`, `--allow-non-loopback`) are stripped; all other tokens stay in
/// the extension remainder.
///
/// # Errors
///
/// Returns [`LoadError::Usage`] for bad flags or values.
pub fn parse_cli_args(args: &[String]) -> Result<CliArgs, LoadError> {
    let mut bind = SocketAddr::from(([127, 0, 0, 1], 0));
    // Packaged shared assets are never overridden by `--ui-root` (d.1 dual mount).
    let shared_ui_root = default_ui_root();
    let mut ui_root = shared_ui_root.clone();
    let mut viewer = resolve_default_viewer()?;
    let mut allow_non_loopback = false;
    let mut workflow_dry_run = false;
    let mut positionals = Vec::new();

    let mut i = 0;
    while i < args.len() {
        let arg = &args[i];
        if arg == "--bind" {
            let value = require_flag_value(args, i, "--bind")?;
            bind = parse_bind(value)?;
            i += 2;
            continue;
        }
        if let Some(value) = arg.strip_prefix("--bind=") {
            bind = parse_bind(value)?;
            i += 1;
            continue;
        }
        if arg == "--allow-non-loopback" {
            allow_non_loopback = true;
            i += 1;
            continue;
        }
        if arg == "--workflow-dry-run" {
            workflow_dry_run = true;
            i += 1;
            continue;
        }
        if arg == "--ui-root" {
            let value = require_flag_value(args, i, "--ui-root")?;
            ui_root = PathBuf::from(value);
            i += 2;
            continue;
        }
        if let Some(value) = arg.strip_prefix("--ui-root=") {
            ui_root = PathBuf::from(value);
            i += 1;
            continue;
        }
        if arg == "--viewer" {
            let value = require_flag_value(args, i, "--viewer")?;
            viewer = parse_viewer(value)?;
            i += 2;
            continue;
        }
        if let Some(value) = arg.strip_prefix("--viewer=") {
            viewer = parse_viewer(value)?;
            i += 1;
            continue;
        }
        if arg == "--version" || arg == "-V" {
            positionals.push(arg.clone());
            i += 1;
            continue;
        }
        // Host-only flags are stripped above. All other tokens — including
        // unknown flags such as `--root` — stay in the extension remainder.
        positionals.push(arg.clone());
        i += 1;
    }

    let dialog_url_env = matches!(viewer, ViewerMode::None);
    Ok(CliArgs {
        host: HostOptions {
            bind,
            ui_root,
            shared_ui_root,
            viewer,
            dialog_url_env,
            dialog_url_file: std::env::var_os("WYVERN_DIALOG_URL_FILE").map(PathBuf::from),
            allow_non_loopback,
            session_timeout: wyvern_host::DEFAULT_SESSION_TIMEOUT,
            mock_picker: None,
        },
        positionals,
        workflow_dry_run,
    })
}

/// Apply extension `host.ui_root` over CLI `--ui-root` when set (contract §7).
pub fn apply_host_overrides(host: &mut HostOptions, overrides: &crate::extensions::HostOverrides) {
    if let Some(ui_root) = &overrides.ui_root {
        host.ui_root = ui_root.clone();
    }
}

fn parse_bind(value: &str) -> Result<SocketAddr, LoadError> {
    value.parse().map_err(|e| LoadError::Usage {
        kind: UsageErrorKind::InvalidBind {
            value: value.to_string(),
        },
        message: format!("invalid --bind '{value}': {e}"),
    })
}

fn require_flag_value<'a>(
    args: &'a [String],
    index: usize,
    flag: &str,
) -> Result<&'a str, LoadError> {
    args.get(index + 1)
        .map(String::as_str)
        .ok_or_else(|| LoadError::Usage {
            kind: UsageErrorKind::MissingFlagValue {
                flag: flag.to_string(),
            },
            message: format!("missing value for {flag}"),
        })
}

fn parse_viewer(value: &str) -> Result<ViewerMode, LoadError> {
    ViewerMode::parse(value).ok_or_else(|| LoadError::Usage {
        kind: UsageErrorKind::InvalidViewer {
            value: value.to_string(),
        },
        message: format!(
            "invalid --viewer '{value}' (expected embedded|none|system|chrome|safari|edge|firefox)"
        ),
    })
}

fn resolve_default_viewer() -> Result<ViewerMode, LoadError> {
    match std::env::var("WYVERN_VIEWER") {
        Err(std::env::VarError::NotPresent) => Ok(ViewerMode::Embedded),
        Err(std::env::VarError::NotUnicode(err)) => Err(LoadError::Usage {
            kind: UsageErrorKind::InvalidWyvernViewerUnicode,
            message: format!("WYVERN_VIEWER is not valid Unicode: {err:?}"),
        }),
        Ok(raw) => {
            if raw.is_empty() {
                Ok(ViewerMode::Embedded)
            } else {
                ViewerMode::parse(&raw).ok_or_else(|| LoadError::Usage {
                    kind: UsageErrorKind::InvalidWyvernViewerEnv {
                        value: raw.clone(),
                    },
                    message: format!(
                        "invalid WYVERN_VIEWER={raw:?}; expected embedded, none, system, or a named viewer path"
                    ),
                })
            }
        }
    }
}

/// Default UI root discovery order:
///
/// 1. `WYVERN_UI_ROOT` environment variable
/// 2. `./ui` (dev workspace — cwd contains ui/)
/// 3. `./share/wyvern/ui` (cwd install layout)
/// 4. `<exe_dir>/share/wyvern/ui` (release tarball layout — REQ-0093 / REQ-0116)
/// 5. `<exe_dir>/ui` (sibling to binary)
/// 6. Embedded assets extracted to platform cache dir (`cargo install` layout)
/// 7. Fallback `./ui` — caller receives a clear "UI not found" error downstream
pub fn default_ui_root() -> PathBuf {
    default_ui_root_with(
        std::env::var("WYVERN_UI_ROOT").ok().as_deref(),
        std::env::current_dir().ok().as_deref(),
        std::env::current_exe()
            .ok()
            .as_deref()
            .and_then(|p| p.parent()),
        true,
    )
}

/// Resolve the default UI root from injectable inputs (QA-001 — no `set_var` in tests).
#[must_use]
pub fn default_ui_root_with(
    ui_root_var: Option<&str>,
    cwd: Option<&Path>,
    exe_dir: Option<&Path>,
    use_embedded_cache: bool,
) -> PathBuf {
    if let Some(path) = ui_root_var {
        return PathBuf::from(path);
    }
    if let Some(cwd) = cwd {
        let cwd_ui = cwd.join("ui");
        if cwd_ui.is_dir() {
            return cwd_ui;
        }
        let cwd_share = cwd.join("share/wyvern/ui");
        if cwd_share.is_dir() {
            return cwd_share;
        }
    } else {
        let cwd_ui = PathBuf::from("ui");
        if cwd_ui.is_dir() {
            return cwd_ui;
        }
        let cwd_share = PathBuf::from("share/wyvern/ui");
        if cwd_share.is_dir() {
            return cwd_share;
        }
    }
    if let Some(exe_dir) = exe_dir {
        let share = exe_dir.join("share/wyvern/ui");
        if share.is_dir() {
            return share;
        }
        let sibling_ui = exe_dir.join("ui");
        if sibling_ui.is_dir() {
            return sibling_ui;
        }
    }
    if use_embedded_cache {
        if let Some(cached) = crate::embedded_ui::extract_to_cache() {
            return cached;
        }
    }
    PathBuf::from("ui")
}

/// Canonical usage text for `--help` / `-h` / `help` and invalid argv.
pub fn usage_message() -> String {
    let mut text = concat!(
        "Usage: wyvern --help | -h | help\n",
        "       wyvern '<json>' | <file.json> | <file.md> | <page.html> | <panel.xhtml> | wizard.json [options]\n",
        "       echo '<json>' | wyvern [options]\n",
        "       wyvern browsers list|refresh\n",
        "       wyvern extensions list|show\n",
        "       wyvern examples list\n",
        "       wyvern wizard lint <path> [<path>...]   Static nav-button lint for wizard packages\n",
        "       wyvern --version\n",
        "\n",
        "Options:\n",
        "  --bind <ADDR:PORT>         HTTP bind (default 127.0.0.1:0)\n",
        "  --allow-non-loopback       Permit non-loopback --bind (0.0.0.0 / LAN)\n",
        "  --ui-root <PATH>           Packaged UI root (default: share/wyvern/ui beside binary).\n",
        "                             For .html / wizard.json, ui-root is inferred from the\n",
        "                             directory that contains wizard.json or pages/. An\n",
        "                             extension host.ui_root replaces this flag.\n",
        "  --viewer <MODE>            embedded|none|system|chrome|safari|edge|firefox\n",
        "                             (default: embedded; CI: WYVERN_VIEWER=none)\n",
        "  --workflow-dry-run         Append --dry-run to wizard workflow pre/post scripts\n",
        "\n",
        "Extensions (see `wyvern extensions list`):\n",
        "  wyvern guide                   # visual feature guide (welcome wizard)\n",
        "  wyvern doc.md\n",
        "  wyvern page.html\n",
        "  wyvern panel.xhtml\n",
        "  wyvern report-xhtml <manifest.json>  # title, optional mode, panels[{path,label,role}]\n",
        "  wyvern report-xhtml --review <manifest.json>  # comments + Approve/Cancel finish\n",
        "  wyvern path/to/wizard.json\n",
        "  wyvern data.csv\n",
        "  wyvern table data.csv          # same interactive table as data.csv\n",
        "  wyvern md data.csv             # CSV as a markdown dialog\n",
        "  wyvern compose render --root DIR --file FILE.j2 [--var k=v] [--var-file vars.json] [--env-prefix PREFIX]\n",
        "\n",
        "Environment:\n",
        "  WYVERN_VIEWER              Override --viewer default\n",
        "  WYVERN_UI_ROOT             Override default UI root discovery\n",
        "  WYVERN_SHARE               Override share/wyvern root (extensions + scripts)\n",
        "\n",
        "Pass a JSON string, .json file, or a path handled by an extension; or pipe JSON on stdin.\n",
        "  See `wyvern extensions list` for the skill index.\n",
        "  See `wyvern examples list` for bundled example READMEs.\n",
        "  Prefix skills answer --help (example: wyvern compose render --help).\n",
    )
    .to_string();
    if let Ok(registry) = ExtensionRegistry::from_json_str(SHIPPED_EXTENSIONS_JSON) {
        let ids = registry
            .extensions()
            .iter()
            .map(|ext| ext.id.to_string())
            .collect::<Vec<_>>()
            .join(", ");
        if !ids.is_empty() {
            text.push_str("Catalog ids for `wyvern extensions show <id>` (not argv commands): ");
            text.push_str(&ids);
            text.push('\n');
        }
    }
    text
}

#[cfg(test)]
mod tests {
    use super::*;

    fn viewer_from_env_with(value: Option<&str>) -> Option<ViewerMode> {
        value.and_then(ViewerMode::parse)
    }

    fn args(items: &[&str]) -> Vec<String> {
        items.iter().map(|s| (*s).to_string()).collect()
    }

    #[test]
    fn viewer_from_env_parses_embedded() {
        assert_eq!(
            viewer_from_env_with(Some("embedded")),
            Some(ViewerMode::Embedded)
        );
    }

    #[test]
    fn default_viewer_mode_when_env_unset() {
        assert_eq!(viewer_from_env_with(None), None);
        assert_eq!(
            viewer_from_env_with(None).unwrap_or(ViewerMode::Embedded),
            ViewerMode::Embedded
        );
    }

    #[test]
    fn invalid_wyvern_viewer_env_is_usage_error() {
        let err = resolve_default_viewer_with(Some("not-a-viewer-mode")).expect_err("invalid");
        assert!(matches!(err, LoadError::Usage { .. }));
    }

    fn resolve_default_viewer_with(value: Option<&str>) -> Result<ViewerMode, LoadError> {
        match value {
            None => Ok(ViewerMode::Embedded),
            Some("") => Ok(ViewerMode::Embedded),
            Some(raw) => ViewerMode::parse(raw).ok_or_else(|| LoadError::Usage {
                kind: UsageErrorKind::InvalidWyvernViewerEnv {
                    value: raw.to_string(),
                },
                message: format!(
                    "invalid WYVERN_VIEWER={raw:?}; expected embedded, none, system, or a named viewer path"
                ),
            }),
        }
    }

    #[test]
    fn parse_viewer_none_explicit() {
        let parsed =
            parse_cli_args(&args(&[r#"{"type":"message"}"#, "--viewer", "none"])).expect("parse");
        assert_eq!(parsed.host.viewer, ViewerMode::None);
        assert!(parsed.host.dialog_url_env);
    }

    #[test]
    fn parse_ui_root_and_bind() {
        let parsed = parse_cli_args(&args(&[
            "--ui-root",
            "./custom-ui",
            "--bind",
            "127.0.0.1:0",
            r#"{"type":"message"}"#,
        ]))
        .expect("parse");
        assert_eq!(parsed.host.ui_root, PathBuf::from("./custom-ui"));
        assert_eq!(parsed.positionals.len(), 1);
    }

    #[test]
    fn parse_bind_rejects_invalid_with_structured_recovery() {
        use crate::error::emit_usage_error;

        let err = parse_cli_args(&args(&["--bind", "not-an-addr"])).expect_err("bind");
        let LoadError::Usage { kind, message } = err else {
            panic!("expected Usage");
        };
        assert!(matches!(kind, UsageErrorKind::InvalidBind { .. }));
        assert!(message.contains("invalid --bind"), "{message}");
        assert!(!message.contains("Recovery:"), "{message}");

        let out = emit_usage_error(&LoadError::Usage { kind, message }).expect("emit");
        let value: serde_json::Value = serde_json::from_str(&out).expect("valid JSON");
        assert!(value["recovery"]
            .as_array()
            .unwrap()
            .iter()
            .any(|s| s.as_str().unwrap().contains("--allow-non-loopback")));
    }

    #[test]
    fn parse_keeps_unknown_flag_in_remainder() {
        let parsed =
            parse_cli_args(&args(&["compose", "render", "--root", "/tmp"])).expect("parse");
        assert_eq!(
            parsed.positionals,
            args(&["compose", "render", "--root", "/tmp"])
        );
    }

    #[test]
    fn parse_strips_host_flags_from_remainder() {
        let parsed = parse_cli_args(&args(&[
            "--viewer",
            "none",
            "--ui-root",
            "./custom-ui",
            "compose",
            "render",
            "--root",
            "/tmp",
        ]))
        .expect("parse");
        assert_eq!(parsed.host.viewer, ViewerMode::None);
        assert_eq!(parsed.host.ui_root, PathBuf::from("./custom-ui"));
        assert_eq!(
            parsed.positionals,
            args(&["compose", "render", "--root", "/tmp"])
        );
    }

    #[test]
    fn default_ui_root_prefers_env_override() {
        let tmp = tempfile::tempdir().expect("tempdir");
        let custom = tmp.path().join("custom-ui");
        std::fs::create_dir_all(&custom).expect("mkdir");
        let root = default_ui_root_with(Some(custom.to_str().expect("utf8")), None, None, false);
        assert_eq!(root, custom);
    }

    #[test]
    fn default_ui_root_falls_back_to_ui_when_nothing_found() {
        let tmp = tempfile::tempdir().expect("tempdir");
        let root = default_ui_root_with(None, Some(tmp.path()), None, false);
        assert_eq!(root, PathBuf::from("ui"));
    }

    #[test]
    fn usage_message_lists_every_shipped_skill() {
        let text = usage_message();
        assert!(text.contains(".csv"), "{text}");
        assert!(text.contains("table"), "{text}");
        assert!(text.contains("md data.csv"), "{text}");
        assert!(text.contains("compose render"), "{text}");
        assert!(text.contains("--env-prefix"), "{text}");
        assert!(text.contains("WYVERN_VIEWER"), "{text}");
        assert!(text.contains("wizard.json or pages/"), "{text}");
        assert!(text.contains("wyvern guide"), "{text}");
        assert!(text.contains("panel.xhtml"), "{text}");
        assert!(text.contains(".xhtml"), "{text}");
        assert!(text.contains("report-xhtml <manifest.json>"), "{text}");
        assert!(
            text.contains("report-xhtml --review <manifest.json>"),
            "{text}"
        );
        assert!(text.contains("panels["), "{text}");
        assert!(text.contains("--workflow-dry-run"), "{text}");
        assert!(text.contains("wyvern wizard lint"), "{text}");
    }

    #[test]
    fn parse_workflow_dry_run_is_on_cli_args_not_host() {
        let parsed = parse_cli_args(&args(&[
            "--workflow-dry-run",
            "--viewer",
            "none",
            r#"{"type":"wizard"}"#,
        ]))
        .expect("parse");
        assert!(parsed.workflow_dry_run);
        assert_eq!(parsed.positionals, args(&[r#"{"type":"wizard"}"#]));
    }
}