Speakeasy Logo
Skip to Content
DocumentationSpeakeasyGeneration ConfigConfig File

The gen.yaml file reference

Tip

For most use cases, the speakeasy configure command is the recommended means of interacting with the Speakeasy gen.yaml file. The speakeasy configure command has subcommands for configuring sources, targets, GitHub workflow setups, and package publications. All new targets created using speakeasy quickstart automatically generate workflow files in the .speakeasy/ folder in the root of the target directory.


The VS Code Speakeasy VS Code extension  provides several useful features for manually editing the gen.yaml file, including syntax highlighting, autocompletion, and linting for OpenAPI documents and other supported file types.

The gen.yaml file has several sections:

  • The generation section is essential for SDK configuration
  • The management and features sections are maintained by Speakeasy and should not be edited
  • The final section is for language-specific configuration (for more information, see the language-specific configuration docs)

Generation

The currently supported version of the Speakeasy gen.yaml configuration file is 2.0.0. Older versions will be automatically upgraded when encountered.

Last updated on