Shared Types CLI Custom Commands

Custom Commands for shared-types-cli

Overview

The shared-types-cli CLI supports user-authored custom commands that are compiled into the binary alongside the auto-generated API commands. Custom commands get a fully-wired SDK client that inherits the CLI's auth, retries, TLS, base URL, and global headers — zero configuration required.

Architecture

cli/shared-types-cli/custom.rs    ← Your command handlers (protected by .fernignore)
cli/shared-types-cli/sdk.rs       ← Generated bridge: client() + block_on()
cli/shared-types-cli/main.rs      ← Generated entrypoint (calls custom::register)
shared-types-cli-sdk/             ← Co-generated typed SDK crate
shared-types-cli-types/           ← Co-generated typed model crate

Adding a Custom Command

1. Edit cli/shared-types-cli/custom.rs

This file is protected by .fernignore — fern generate will never overwrite it. Register commands in the register() function:

use shared_types_cli_sdk::api::*;

pub fn register(app: CliApp) -> CliApp {
    let app = app.command(
        clap::Command::new("list-items")
            .about("List catalog items")
        ,
        |matches, ctx| {
            let client = super::sdk::client(ctx);
            let result = super::sdk::block_on(
                client.catalog.list_items(),
            )?;
            println!("{}", serde_json::to_string_pretty(&result).unwrap());
            Ok(())
        },
    );
    app
}

Then build and test:

cargo build
shared-types-cli list-items

2. Available SDK Clients

The super::sdk::client(ctx) call returns a shared_types_cli_sdk::api::Client with the following sub-clients:

3. Key Patterns

Get the SDK client (execution-sharing, fully authenticated):

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

Run an async SDK call from a sync handler:

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

Use typed models for request/response serialization:

use shared_types_cli_sdk::api::*;

Regeneration Safety

After running fern generate, your custom.rs is preserved. All generated code (SDK, types, glue, main.rs) is updated to match the latest API spec. If the SDK surface changes (renamed methods, new sub-clients), update your custom.rs to match.

Build & Test

# Build the CLI (includes custom commands)
cargo build

# Run your custom command
shared-types-cli <your-command> [args]

# Run with verbose output for debugging
RUST_LOG=debug shared-types-cli <your-command> [args]