scriba 0.4.0

CLI text rendering, prompts, and terminal output utilities
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

//! Flat JSON envelope — the default layout.
//!
//! All fields (`ok`, `format`, content, `meta`) appear at the top level.
//!
//! Run with:
//! ```sh
//! cargo run --example envelope_flat
//! ```

use scriba::{
    Format, Output,
    Ui,
    envelope::{EnvelopeConfig, EnvelopeLayout, EnvelopeMode, Meta},
};

fn main() -> scriba::Result<()> {
    let output = Output::new()
        .title("Deployment")
        .data("environment", "production")
        .data("version", "1.4.2")
        .paragraph("All services healthy.");

    let ui = Ui::new()
        .with_format(Format::Json)
        .with_envelope(
            EnvelopeConfig::default()
                .with_mode(EnvelopeMode::Json)
                .with_layout(EnvelopeLayout::Flat),
        );

    println!("=== Flat envelope, no meta ===");
    ui.print(&output)?;

    println!("\n=== Flat envelope, with meta ===");
    let meta = Meta::default()
        .with_dry_run(false)
        .with_command("deploy".into())
        .with_duration_ms(312)
        .with_timestamp("2026-04-13T15:00:00Z".into());
    ui.print_with_meta(&output, Some(&meta), true)?;

    println!("\n=== Flat envelope, ok: false (error case) ===");
    let error_output = Output::new()
        .title("Deployment")
        .paragraph("Health check failed on eu-west-1.");
    ui.print_with_meta(&error_output, None, false)?;

    Ok(())
}