elevenlabs-custom-commands

name	elevenlabs-custom-commands
description	How to author custom commands for the elevenlabs CLI using the co-generated SDK.

Custom Commands for elevenlabs

Overview

The elevenlabs 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/elevenlabs/custom.rs    ← Your command handlers (protected by .fernignore)
cli/elevenlabs/sdk.rs       ← Generated bridge: client() + block_on()
cli/elevenlabs/main.rs      ← Generated entrypoint (calls custom::register)
elevenlabs-sdk/             ← Co-generated typed SDK crate
elevenlabs-types/           ← Co-generated typed model crate

Adding a Custom Command

1. Edit cli/elevenlabs/custom.rs

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

use elevenlabs_sdk::api::*;

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

Then build and test:

cargo build
elevenlabs get <history_item_id>

2. Available SDK Clients

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

Field	Type	Description
client.history	elevenlabs_sdk::api::HistoryClient	history operations
client.text_to_sound_effects	elevenlabs_sdk::api::TextToSoundEffectsClient	text_to_sound_effects operations
client.audio_isolation	elevenlabs_sdk::api::AudioIsolationClient	audio_isolation operations
client.samples	elevenlabs_sdk::api::SamplesClient	samples operations
client.text_to_speech	elevenlabs_sdk::api::TextToSpeechClient	text_to_speech operations
client.text_to_dialogue	elevenlabs_sdk::api::TextToDialogueClient	text_to_dialogue operations
client.speech_to_speech	elevenlabs_sdk::api::SpeechToSpeechClient	speech_to_speech operations
client.text_to_voice	elevenlabs_sdk::api::TextToVoiceClient	text_to_voice operations
client.preview	elevenlabs_sdk::api::PreviewClient	preview operations
client.user	elevenlabs_sdk::api::UserClient	user operations
client.subscription	elevenlabs_sdk::api::SubscriptionClient	subscription operations
client.voices	elevenlabs_sdk::api::VoicesClient	voices operations
client.settings	elevenlabs_sdk::api::SettingsClient3	settings operations
client.accents	elevenlabs_sdk::api::AccentsClient	accents operations

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 elevenlabs_sdk::api::*;

4. Authentication

Custom commands automatically inherit the CLI's authentication. The following auth schemes are configured:

• OAuth (oauth-authorization-code): env ``

No manual auth wiring is needed in custom command handlers.

Regeneration Safety

File	Regenerated?	Notes
cli/elevenlabs/custom.rs	No	Protected by .fernignore
cli/elevenlabs/sdk.rs	Yes	Bridges AppContext → SDK client
cli/elevenlabs/main.rs	Yes	Calls custom::register(app)
elevenlabs-sdk/	Yes	Co-generated typed SDK crate
elevenlabs-types/	Yes	Co-generated typed models

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
elevenlabs <your-command> [args]

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