url-form-encoded-api-custom-commands

How to author custom commands for the url-form-encoded-api CLI using the co-generated SDK.

Quality

57%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

Securityby

Passed

No findings from the security scan

Fix and improve this skill with Tessl

tessl review fix ./seed/cli/url-form-encoded/.agents/skills/custom-commands/SKILL.md

Custom Commands for `url-form-encoded-api`

Overview

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

Adding a Custom Command

1. Edit `cli/url-form-encoded-api/custom.rs`

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

use url_form_encoded_api_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. Available SDK Clients

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

(Sub-clients are derived from the API spec at generation time.)

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

Regeneration Safety

File	Regenerated?	Notes
`cli/url-form-encoded-api/custom.rs`	No	Protected by `.fernignore`
`cli/url-form-encoded-api/sdk.rs`	Yes	Bridges AppContext → SDK client
`cli/url-form-encoded-api/main.rs`	Yes	Calls `custom::register(app)`
`url-form-encoded-api-sdk/`	Yes	Co-generated typed SDK crate
`url-form-encoded-api-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
url-form-encoded-api <your-command> [args]

# Run with verbose output for debugging
RUST_LOG=debug url-form-encoded-api <your-command> [args]

Repository: fern-api/fern
Path: seed/cli/url-form-encoded/.agents/skills/custom-commands/SKILL.md
Commit: 44279be

Last updated: 2 days ago
First committed: about 1 month ago

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.