OpenParable
Skip to content
← Back to skills

Query Param Name Conflict API Custom Commands

Development
query-param-name-conflict-api-custom-commands

Query Param Name Conflict API Custom Commands is an Agent Skill for development published in the fern-api/fern repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

How to author custom commands for the query-param-name-conflict-api CLI using the co-generated SDK.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/fern-api/fern/blob/HEAD/seed/cli/query-param-name-conflict/.agents/skills/custom-commands/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/query-param-name-conflict-api-custom-commands, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Custom Commands for query-param-name-conflict-api

Overview

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

Adding a Custom Command

1. Edit cli/query-param-name-conflict-api/custom.rs

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

use query_param_name_conflict_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 query_param_name_conflict_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 query_param_name_conflict_api_sdk::api::*;

Regeneration Safety

FileRegenerated?Notes
cli/query-param-name-conflict-api/custom.rsNoProtected by .fernignore
cli/query-param-name-conflict-api/sdk.rsYesBridges AppContext → SDK client
cli/query-param-name-conflict-api/main.rsYesCalls custom::register(app)
query-param-name-conflict-api-sdk/YesCo-generated typed SDK crate
query-param-name-conflict-api-types/YesCo-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
query-param-name-conflict-api <your-command> [args]

# Run with verbose output for debugging
RUST_LOG=debug query-param-name-conflict-api <your-command> [args]