Quick start

The boe (Built On Envoy) CLI provides a zero-friction developer experience for discovering, running, and building Envoy® Proxy extensions.

Installation

Choose your preferred installation method:

Install script

curl -sL https://builtonenvoy.io/install.sh | sh

Homebrew

brew tap tetratelabs/boe
brew install boe

Build from source

You need to have Go >= 1.25 and make to build from source.

git clone https://github.com/tetratelabs/built-on-envoy
cd built-on-envoy/cli
make

CLI quick start

Once installed, you can immediately start using extensions:

Discover available extensions

Discover all publicly available extensions:

boe list

Run extensions

Easily run any extension. The boe CLI will automatically download Envoy for your operating system and architecture, and start it preconfigured with the requested extensions and a test upstream. By default it will proxy traffic to https://httpbin.org unless a different test upstream host is set with the --test-upstream-host parameter:

boe run --extension example-go

Or run extensions directly from a local directory:

boe run --local ./my-extension

Next steps

• Explore the CLI Commands:
  • boe create - Create your first extension.
  • boe run - Run Envoy with extensions.
• Read about the different extension types.
• Create your own extensions:
  • Create and run extensions locally.
  • Create your first Go extension.
  • Create your first Rust extension.
• Export the configuration and compiled extensions for external use.
• Browse the Extensions Catalog to find extensions for your use case.
• Check the Extension Manifest Reference to create your own extensions.