Envoy Logo

boe download

The download command is used to download the contents of published extension packages for a specific platform to a given directory. By default it downloads the packages for the current platform.

This command is mostly useful to download a compiled version of an extension to use it in production or other environments. Unlike the gen-config command, this one can be used to download compiled extensions for a concrete target paltform.

Download extensions for a given platform:

boe download ip-restriction --platform linux/amd64
boe download example-go --platform linux/amd64 --path /tmp/extensions

Download the composer dynamic module that bundles all Go extensions:

boe download composer --platform linux/amd64

Usage details

boe download <extension> [flags]
boe download --help

Arguments

NameDescriptionTypeRequired
extensionThe name of the extension to download. For example, ‘example-go’.stringYes

Flags

NameDescriptionTypeDefaultEnv VarRequired
--platformThe target platform for the extension in the format os/arch. For example, ‘linux/amd64’. If not specified, it defaults to the current platform.string--No
--devWhether to allow downloading dev versions of extensions (with -dev suffix). By default, only stable versions are allowed.boolfalse-No
--pathDirectory to put the downloaded extension artifact into. Defaults to the current directory.string.-No
--registryOCI registry URL for the extensions.stringghcr.io/tetratelabs/built-on-envoyBOE_REGISTRYNo
--insecureAllow connecting to an insecure (HTTP) registry.boolfalseBOE_REGISTRY_INSECURENo
--usernameUsername for the OCI registry.string-BOE_REGISTRY_USERNAMENo
--passwordPassword for the OCI registry.string-BOE_REGISTRY_PASSWORDNo