spec-driven-docs 0.3.2

Spec-driven documentation: current specs, immutable decision records, and executable gates kept coherent for people and 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
74
75
76
77
78
79
80
81
82

//! Root clap parser.
//!
//! Holds the top-level [`Cli`], the [`Commands`] enum, and the global args.
//! Per-subcommand arg structs live in sibling files (`cli/<name>.rs`). No
//! business logic anywhere in this module tree.

pub mod completions;
pub mod gate;
pub mod hooks;
pub mod init;
pub mod license;
pub mod read;
pub mod skill;
pub mod status;
pub mod upgrade;
pub mod verify;

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

/// The `sdd` command line.
#[derive(Debug, Parser)]
#[command(name = "sdd", version, about, long_about = None)]
pub struct Cli {
    /// Flags every subcommand shares.
    #[command(flatten)]
    pub global: GlobalArgs,

    /// The subcommand to run.
    #[command(subcommand)]
    pub command: Commands,
}

/// Flags every subcommand shares.
#[derive(Debug, clap::Args)]
pub struct GlobalArgs {
    /// Increase log verbosity (-v info, -vv debug, -vvv trace).
    /// Overridden by `RUST_LOG` if set.
    #[arg(short, long, action = ArgAction::Count, global = true)]
    pub verbose: u8,
}

/// Every subcommand `sdd` offers.
#[derive(Debug, Subcommand)]
pub enum Commands {
    /// Install the payload into a target repository.
    Init(init::InitArgs),
    /// Verify an installed instance offline.
    Verify(verify::VerifyArgs),
    /// Upgrade an installed instance to this binary's version.
    Upgrade(upgrade::UpgradeArgs),
    /// Run one delivered gate, or list them all.
    Gate(gate::GateArgs),
    /// Render the delivered gate set as pre-commit hook entries.
    Hooks(hooks::HooksArgs),
    /// Read a method chapter, or list them.
    Method(read::ReadArgs),
    /// Read a spec seed, or list them.
    Spec(read::ReadArgs),
    /// Read a document template, or list them.
    Template(read::ReadArgs),
    /// Read the embedded skills, or install them for coding agents.
    Skill(skill::SkillArgs),
    /// Report an instance's state without gating on it.
    Status(status::StatusArgs),
    /// Print the license terms this binary carries.
    License(license::LicenseArgs),
    /// Regenerate the canon checkout's own instance manifest.
    SelfManifest,
    /// Generate shell completions.
    Completions(completions::CompletionsArgs),
    /// Render the manual page.
    Man,
}

/// Every subcommand name the binary answers to.
#[must_use]
pub fn subcommand_names() -> Vec<String> {
    <Cli as clap::CommandFactory>::command()
        .get_subcommands()
        .map(|command| command.get_name().to_string())
        .collect()
}