zad-cli 0.6.4

Command-line interface for zad — connects AI agents to external services (Discord, Slack, Google Calendar, Spotify, Telegram, YouTube Music, 1Password) via scoped service configurations.
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

//! Implementation of the `zad docs [topic]` subcommand mandated by
//! `OSS_SPEC.md` §12.3.
//!
//! Every topic doc under `docs/*.md` is embedded into the binary via
//! `include_str!` so the exact text a contributor ships is the exact
//! text an agent sees at runtime — no filesystem lookups, no version
//! skew between the installed binary and the source tree.
//!
//! Paths resolve through the `crates/zad-cli/docs` symlink, which
//! points at `../../docs` (the canonical docs tree at the repo root).
//! The symlink is resolved when cargo packages the crate, so the
//! published tarball ships the doc files as real entries and the
//! `cargo publish` verify step can compile the package outside the
//! workspace. Don't replace the symlink with copies — that would
//! immediately drift from the canonical docs.

use std::fmt::Write as _;

use clap::Args;

use zad::error::{Result, ZadError};

#[derive(Debug, Args)]
pub struct DocsArgs {
    /// Topic name (without the `.md` extension). When omitted, lists the
    /// available topics.
    pub topic: Option<String>,
}

const TOPICS: &[(&str, &str)] = &[
    ("architecture", include_str!("../../docs/architecture.md")),
    ("configuration", include_str!("../../docs/configuration.md")),
    (
        "getting-started",
        include_str!("../../docs/getting-started.md"),
    ),
    (
        "troubleshooting",
        include_str!("../../docs/troubleshooting.md"),
    ),
];

pub fn run(args: DocsArgs) -> Result<()> {
    match args.topic {
        None => {
            let mut out = String::new();
            out.push_str("Available topics (run `zad docs <topic>` to read):\n");
            for (name, _) in TOPICS {
                let _ = writeln!(out, "  {name}");
            }
            print!("{out}");
            Ok(())
        }
        Some(topic) => match TOPICS.iter().find(|(n, _)| *n == topic) {
            Some((_, body)) => {
                print!("{body}");
                Ok(())
            }
            None => Err(ZadError::Invalid(format!(
                "no such docs topic: `{topic}`. Run `zad docs` to list available topics."
            ))),
        },
    }
}