Skip to Content
DocumentationSpeakeasyGeneration ConfigCLI Configuration

CLI configuration options

Alpha · Enterprise Only

CLI generation is currently in alpha and available exclusively to Enterprise customers. Contact us  for access.

This section details the available configuration options for the CLI target. All configuration is managed in the gen.yaml file under the cli section.

Fields marked as required are always present in gen.yaml and auto-populated with defaults during speakeasy quickstart. They can be overridden but must not be removed.

Version and general configuration

cli:
  version: 0.1.0
  packageName: "github.com/my-company/my-api-cli"
  cliName: "my-api"
  envVarPrefix: "MY_API"
Name
version
Required
true
Description
The current version of the CLI. Injected into the binary via ldflags during GoReleaser builds.
Default Value
0.0.1
packageName
Required
true
Description
The Go module path for the CLI project (e.g.,
). Used in
and for
commands.
Default Value
openapi
cliName
Required
true
Description
The binary name users type to run the CLI. Also determines the config directory path (
), shell completion commands, and documentation references.
Default Value
cli
envVarPrefix
Required
true
Description
Prefix for environment variables the CLI reads. For example, with prefix
, the CLI checks for
,
,
, etc.
Default Value
CLI

Command behavior

cli:
  removeStutter: true
Name
removeStutter
Required
false
Description
When enabled, removes redundant prefixes from command names. If an operation name shares a prefix with its tag group, the prefix is stripped (e.g.,
becomes
). Exact matches are promoted to the parent group.
Default Value
true

Release and distribution

cli:
  generateRelease: true
Name
generateRelease
Required
false
Description
When enabled, generates GoReleaser configuration (
), GitHub Actions release workflow, and platform install scripts (
and
). Disable if you manage releases separately.
Default Value
true

Custom code

cli:
  enableCustomCodeRegions: true
Name
enableCustomCodeRegions
Required
false
Description
Enable custom code regions that allow hand-written code to be inserted into generated files. Marked regions are preserved across regenerations. See custom code regions for details.
Default Value
false

Additional dependencies

cli:
  additionalDependencies:
    github.com/my-company/my-package: "v1.2.3"
Name
additionalDependencies
Required
false
Description
Add additional Go module dependencies to the generated
. Useful when custom code regions import external packages.
Default Value
{}

Error type naming

cli:
  baseErrorName: "SDKError"
  defaultErrorName: "SDKDefaultError"
Name
baseErrorName
Required
false
Description
The name of the base error type in the generated SDK.
Default Value
SDKError
defaultErrorName
Required
false
Description
The name of the default error type in the generated SDK.
Default Value
SDKDefaultError

Last updated on