Commandes personnalisées pour acme-cli

Aperçu

Le CLI acme-cli supporte les commandes personnalisées écrites par les utilisateurs qui sont compilées dans le binaire aux côtés des commandes API auto-générées. Les commandes personnalisées reçoivent un client SDK complètement configuré qui hérite de l'authentification, des retries, du TLS, de l'URL de base et des headers globaux du CLI — aucune configuration requise.

Architecture

cli/acme-cli/custom.rs    ← Vos gestionnaires de commandes (protégés par .fernignore)
cli/acme-cli/sdk.rs       ← Pont généré : client() + block_on()
cli/acme-cli/main.rs      ← Point d'entrée généré (appelle custom::register)
acme-cli-sdk/             ← Crate SDK typé co-généré
acme-cli-types/           ← Crate de modèles typés co-généré

Ajouter une commande personnalisée

1. Modifiez cli/acme-cli/custom.rs

Ce fichier est protégé par .fernignore — fern generate ne le réécrira jamais. Enregistrez les commandes dans la fonction register() :

use acme_cli_sdk::api::*;

pub fn register(app: CliApp) -> CliApp {
    let app = app.command(
        clap::Command::new("my-command")
            .about("Description of your command")
            .arg(clap::Arg::new("id").required(true)),
        |matches, ctx| {
            let id = matches.get_one::<String>("id").unwrap();
            let client = super::sdk::client(ctx);
            let result = super::sdk::block_on(
                client.resource.get(id),
            )?;
            println!("{}", serde_json::to_string_pretty(&result).unwrap());
            Ok(())
        },
    );
    app
}

2. Clients SDK disponibles

L'appel super::sdk::client(ctx) retourne un acme_cli_sdk::api::Client avec les sous-clients suivants :

(Les sous-clients sont dérivés de la spécification API au moment de la génération.)

3. Motifs clés

Obtenir le client SDK (partage d'exécution, complètement authentifié) :

let client = super::sdk::client(ctx);

Exécuter un appel SDK asynchrone depuis un gestionnaire synchrone :

let result = super::sdk::block_on(
    client.some_resource.some_method(args),
)?;

Utiliser des modèles typés pour la sérialisation requête/réponse :

use acme_cli_sdk::api::*;

Sécurité de régénération

Après avoir exécuté fern generate, votre custom.rs est conservé. Tout le code généré (SDK, types, glue, main.rs) est mis à jour pour correspondre à la dernière spécification API. Si la surface du SDK change (méthodes renommées, nouveaux sous-clients), mettez à jour votre custom.rs en conséquence.

Build & Test

# Builder le CLI (inclut les commandes personnalisées)
cargo build

# Exécuter votre commande personnalisée
acme-cli <your-command> [args]

# Exécuter avec sortie verbale pour déboguer
RUST_LOG=debug acme-cli <your-command> [args]