Struct CliDocsGenerator 

pub struct CliDocsGenerator;

CLI documentation generator for creating JSON documentation from Clap CLI structures

This is a stateless utility that uses Clap’s introspection APIs to extract comprehensive CLI metadata and convert it to a structured JSON documentation format.

Architecture

• Uses CommandFactory trait to access CLI structure
• Recursively traverses commands and subcommands
• Delegates JSON construction to schema_builder module

Examples

use clap::Parser;
use torrust_tracker_deployer_lib::infrastructure::cli_docs::CliDocsGenerator;

#[derive(Parser)]
struct MyCli {
    #[arg(short, long)]
    verbose: bool,
}

let docs = CliDocsGenerator::generate::<MyCli>()?;
assert!(docs.contains("\"name\""));

Implementations

impl CliDocsGenerator

pub fn generate<T: CommandFactory>() -> Result<String, CliDocsGenerationError>

Generates JSON documentation for the given CLI type

The type must implement CommandFactory from Clap, which is automatically provided by the #[derive(Parser)] macro.

Type Parameters

• T - The CLI type to generate documentation for (must implement CommandFactory)

Returns

• Ok(String) - The JSON documentation as a pretty-printed JSON string
• Err(CliDocsGenerationError) - If documentation generation or serialization fails

Examples

use clap::Parser;
use torrust_tracker_deployer_lib::infrastructure::cli_docs::CliDocsGenerator;

#[derive(Parser)]
#[command(name = "my-app", version = "1.0.0", about = "My application")]
struct MyCli {
    #[arg(short, long)]
    verbose: bool,
}

let docs = CliDocsGenerator::generate::<MyCli>()?;
assert!(docs.contains("my-app"));
assert!(docs.contains("verbose"));

Errors

Returns CliDocsGenerationError::SerializationFailed if the documentation cannot be serialized to JSON (this should be extremely rare).