Skip to navigation

Set the CLI's display name

You can now set displayName to control the API name in the generated README and reference.md titles and in the crate’s default description. A multi-spec workspace no longer takes its title from the first spec’s info.title; without displayName, it uses a readable form of the binary name (twilio-cli gives “Twilio CLI”).

Read the docs
generators.yml

Accurate reference.md command paths

The generated reference.md now lists the command paths the binary runs:

  • A group named like its spec’s namespace is hoisted into the namespace (oauth authorize, not oauth oauth authorize).
  • A slash-separated namespace nests (messaging bulk-messages create, not messaging-bulk-messages create).
  • HEAD and OPTIONS operations, such as CORS preflight endpoints, are no longer listed, since the binary doesn’t expose them.
  • Titles no longer double “CLI” when the name already ends in it.
commands

Shared resources across specs merge

Specs under the same namespace that define a resource with the same name now merge that resource’s commands instead of failing at startup with Resource key collision. The CLI errors only when two specs define the same command, and the error names the full command path.

Read the docs
generators.yml

macOS code signing in the release workflow

The generated release workflow now code-signs the macOS binaries when the CLI repository has the CODESIGN_CERTIFICATE, CODESIGN_CERTIFICATE_PASSWORD, and CODESIGN_IDENTITY secrets (an Apple Developer ID certificate). macOS keychain credentials are also read through /usr/bin/security, so one “Always Allow” lasts across upgrades.

Read the docs
publishing

Startup banner on root --help

The banner option prints ASCII art on root --help. It can be a solid color, a multi-stop RGB gradient (horizontal, vertical, or diagonal), one color per line, or pre-colored ANSI art. Set banner.animate: true to play a short shimmer in interactive terminals.

Read the docs
featuresgenerators.yml

Table columns with x-fern-cli-table

The x-fern-cli-table operation extension sets the columns that --format table shows for a command: header, field path, order, alignment, max width, date formatting, and optional hidden columns.

Read the docs
features

Prompts for missing required inputs

When stdin and stderr are both terminals, the CLI prompts for required inputs that no flag, --params, --json, profile, or global parameter supplied. Scripts, CI, and piped runs never prompt and keep the existing “is missing” error. Values marked format: email are now validated before the request is sent.

Read the docs
commands

Shorthand values for object flags

A flag whose value is an object with exactly one required string property now also accepts a plain value for that property: --from a@x.com sends {"email":"a@x.com"}, and --to a@x.com,b@x.com sends one object per entry. Values the spec marks format: email are validated before the request is sent.

Read the docs
features

Guided API-key setup

CLIs with profiles.provisionOperation configured now walk users through creating a key-backed profile in an interactive terminal. auth login and a bare profiles create <name> ask for a profile name and the credential, offer to create an API key with it, and store only the new key. profiles remove offers to revoke the profile’s key. provisionOperation also accepts flag, parameters, and profileParameters.

authgenerators.yml

Release workflow works on private repositories

GitHub artifact attestations require GitHub Enterprise Cloud on private repositories, so the generated release workflow failed every build there. The new distribution.githubAttestations option controls the attest step, and by default it runs only on public repositories.

Read the docs
publishinggenerators.yml

Server variables in a custom base URL

Placeholders such as {region} in a caller-supplied base URL (--base-url, <NAME>_BASE_URL, or a profile’s base URL) are now filled from the matching flag, profile, environment variable, or spec default. Previously the literal placeholder was sent and the request failed.

Read the docs
features

Installers download from your repository

When the generator delivers to a GitHub repository, the crate’s name, repository, and homepage now default from that repository unless packageIdentity sets them. The shell and PowerShell installers download from your releases, and release assets are named <binaryName>-* instead of fern-cli-sdk-*.

Read the docs
publishinggenerators.yml

--schema describes custom commands

<cli> <custom-command> --schema now returns the command’s description and flags instead of failing with a discovery error, and root --schema lists registered custom commands in a customCommands array. Agents that discover commands through --schema can now see hand-written commands.

Read the docs
commands

Faster shell completion on large CLIs

<cli> completion <shell> now prints a small script that asks the CLI for candidates on each Tab, instead of a static script containing the whole command tree. On a CLI with about 13,700 commands, the zsh script was 14 MB and took over a minute to load on the first Tab.

Read the docs
commands

Prefixed API-key headers

Header API-key schemes now send their configured prefix. An auth-schemes entry such as { header: X-Api-Key, prefix: Key } sends X-Api-Key: Key <credential> whether the key comes from the flag, the environment variable, or the keyring entry auth login stores. Previously the bare credential was sent.

Read the docs
auth

Create API keys with profiles create --provision

Set profiles.provisionOperation to the operation that creates an API key (for example iam.keys.create). profiles create then gains --provision, which calls that operation with the credentials already in the environment and saves the returned key to the new profile. It’s the create-side counterpart of revokeOperation.

Read the docs
authgenerators.yml

Auth details in dry-run previews

--dry-run output now includes an auth block that reports the endpoint’s security schemes and whether credentials would be attached (resolved, missing, or supplied). In a terminal, the default table format now prints the full request preview (URL, method, query parameters, and body) instead of only the header rows.

Read the docs
features

profiles set confirms before creating a profile

profiles set <name> no longer creates a missing profile without asking, so a mistyped name can’t save credentials to a new, unintended profile. In a terminal it asks first, offering a similarly named existing profile before asking whether to create the new one; declining writes nothing. When stdin or stderr isn’t a terminal, set on a missing profile fails with a hint instead of creating it. Scripts that relied on set to create profiles need the new --yes / -y flag or a profiles create call first. Updating an existing profile is unchanged.

auth

Selected profiles outrank environment variables

A selected profile’s stored values now take precedence over environment variables however the profile was selected: -p, <PREFIX>_PROFILE, or profiles use. Previously only a profile named with -p outranked the environment, so a profile made active with profiles use lost to any exported <PREFIX>_BASE_URL, <PREFIX>_RETRIES, or credential variable. Every profile-capable value resolves as explicit flag → selected profile → environment variable → spec default; environment variables fill only the values the profile leaves unset. Unprofiled invocations are unchanged. auth status lists the profile’s credential source before the environment variable, and profiles current reports when an environment variable is supplying a credential the profile doesn’t store.

auth

Profile-storable transport settings

profiles set now accepts <PREFIX>_TIMEOUT_SECS, <PREFIX>_PROXY, <PREFIX>_CA_BUNDLE, <PREFIX>_INSECURE, and <PREFIX>_USER_AGENT_SUFFIX, so each profile can carry its own request timeout, proxy, CA bundle, TLS verification setting, and User-Agent suffix. Values are validated on save, child profiles inherit them, and a selected profile’s value outranks the exported variable. <PREFIX>_CONNECT_TIMEOUT_SECS stays environment-only. The root --help footer now lists every environment variable the CLI reads, including one per server URL variable.

features