omne-cli 0.1.1

CLI for managing omne volumes: init, upgrade, and validate kernel and distro releases
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

//! Top-level clap parser and subcommand enum.
//!
//! Adding a new subcommand is a mechanical three-edit change: a new
//! `src/commands/<name>.rs` module with an `Args` struct and `run()`
//! function, a `pub mod <name>;` line in `src/commands/mod.rs`, and a
//! new variant on `Command` below. The exhaustive match in `main.rs`
//! forces the compiler to refuse to build until the dispatcher is
//! wired up, which is the structural encoding of R11.

use clap::{Parser, Subcommand};

use crate::commands;

#[derive(Debug, Parser)]
#[command(
    name = "omne",
    version,
    about = "Manage omne volumes: init, upgrade, validate",
    long_about = "omne is a CLI for managing omne volumes. It fetches kernel \
and distro release tarballs from GitHub Releases, scaffolds a `.omne/` \
directory, and validates volume integrity. \
\n\nPhase 1 status: this build is a scaffold. The init, upgrade, and \
validate subcommands are stub handlers that exit 0 without doing real \
work; the operational behavior described below lands in subsequent units.\
\n\nAuthentication: set GITHUB_TOKEN or GH_TOKEN to raise the GitHub API \
rate limit from 60/hour to 5000/hour. When both are set, GITHUB_TOKEN wins.\
\n\nExit codes:\n  0  success\n  1  logical error (bad specifier, volume \
not found, validation failure)\n  2  argument parse error",
    subcommand_required = true,
    arg_required_else_help = false
)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Command,
}

#[derive(Debug, Subcommand)]
pub enum Command {
    /// Initialize a new omne volume in the current directory.
    Init(commands::init::Args),

    /// Upgrade the kernel or distro to the latest release.
    Upgrade(commands::upgrade::Args),

    /// Check volume integrity and run the distro gate runner.
    Validate(commands::validate::Args),
}