zig-core 0.5.6

Core library for zig — workflow orchestration engine for AI coding agents
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

/// Embedded manpage content, compiled from `manpages/` markdown files.
mod pages {
    pub const ZIG: &str = include_str!("../manpages/zig.md");
    pub const RUN: &str = include_str!("../manpages/run.md");
    pub const LISTEN: &str = include_str!("../manpages/listen.md");
    pub const SERVE: &str = include_str!("../manpages/serve.md");
    pub const WORKFLOW: &str = include_str!("../manpages/workflow.md");
    pub const DESCRIBE: &str = include_str!("../manpages/describe.md");
    pub const VALIDATE: &str = include_str!("../manpages/validate.md");
    pub const ZUG: &str = include_str!("../manpages/zug.md");
    pub const PATTERNS: &str = include_str!("../manpages/patterns.md");
    pub const VARIABLES: &str = include_str!("../manpages/variables.md");
    pub const CONDITIONS: &str = include_str!("../manpages/conditions.md");
    pub const RESOURCES: &str = include_str!("../manpages/resources.md");
}

/// All available manpage topics in display order.
pub const TOPICS: &[(&str, &str)] = &[
    ("zig", "Overview of the zig CLI"),
    ("run", "Execute a .zug workflow file"),
    ("listen", "Tail a running or completed zig session"),
    ("serve", "Start an HTTP API server"),
    (
        "workflow",
        "Manage workflows (list, show, create, delete, pack)",
    ),
    ("describe", "Generate a .zug file from a prompt"),
    ("validate", "Validate a .zug workflow file"),
    ("zug", "The .zug workflow format"),
    ("patterns", "Orchestration patterns"),
    ("variables", "Variable system and data flow"),
    ("conditions", "Condition expressions"),
    ("resources", "Reference files advertised to step agents"),
];

/// Look up a manpage by topic name.
///
/// Returns the markdown content if the topic exists, or `None`.
pub fn get(topic: &str) -> Option<&'static str> {
    match topic {
        "zig" => Some(pages::ZIG),
        "run" => Some(pages::RUN),
        "listen" => Some(pages::LISTEN),
        "serve" => Some(pages::SERVE),
        "workflow" => Some(pages::WORKFLOW),
        "describe" => Some(pages::DESCRIBE),
        "validate" => Some(pages::VALIDATE),
        "zug" => Some(pages::ZUG),
        "patterns" => Some(pages::PATTERNS),
        "variables" => Some(pages::VARIABLES),
        "conditions" => Some(pages::CONDITIONS),
        "resources" => Some(pages::RESOURCES),
        _ => None,
    }
}

/// List all available manpage topics with their descriptions.
pub fn list_topics() -> String {
    let mut out = String::from("Available manpages:\n\n");
    let max_name_len = TOPICS.iter().map(|(name, _)| name.len()).max().unwrap_or(0);
    for (name, description) in TOPICS {
        out.push_str(&format!(
            "  {name:<width$}  {description}\n",
            width = max_name_len
        ));
    }
    out.push_str("\nUsage: zig man <topic>");
    out
}

#[cfg(test)]
#[path = "man_tests.rs"]
mod tests;