boe ui

This command provides a web console to browse, configure, and run Built On Envoy extensions. It opens automatically in your default browser.

Features

Browse the full extension catalog with search and filters
Configure extensions using auto-generated forms based on JSON Schema
Reorder extensions in the HTTP filter chain
Run Envoy with selected extensions using boe run

Examples

Start the UI on the default port (18000):

boe ui

Start the UI on a custom port customizing the Envoy log levels:

boe ui --port 9090 --log-level dynamic_modules:debug

Start the UI enabling also some local extensions:

boe ui --local /path/to/my/extension1 --local /path/to/my/extension2

Start the UI to run the extensions against a custom upstream host instead of the default httpbin.org:

boe ui --test-upstream-host api.openai.com

Usage details

boe ui [flags]
boe ui --help

Flags

Name	Description	Type	Default	Env Var	Required
`--port`	HTTP server port.	`int`	`18000`	-	No
`--log-level`	Envoy component log level.	`string`	`all:error`	`ENVOY_LOG_LEVEL`	No
`--envoy-version`	Envoy version to use (e.g., 1.31.0, dev, dev-latest)	`string`	-	`ENVOY_VERSION`	No
`--envoy-path`	Path to a custom Envoy binary. Skips Envoy download and version selection.	`string`	-	`ENVOY_PATH`	No
`--local`	Path to a directory containing a local Extension to enable.	`[]string`	-	-	No
`--dev`	Whether to allow downloading dev versions of extensions (with -dev suffix). By default, only stable versions are allowed.	`bool`	`false`	-	No
`--cluster`	Optional additional Envoy cluster provided in the host:tlsPort pattern.	`[]string`	-	-	No
`--cluster-insecure`	Optional additional Envoy cluster (with TLS transport disabled) provided in the host:port pattern.	`[]string`	-	-	No
`--cluster-json`	Optional additional Envoy cluster providing the complete cluster config in JSON format.	`[]string`	-	-	No
`--test-upstream-host`	Hostname for the test upstream cluster. Mutually exclusive with —test-upstream-cluster. Defaults to “httpbin.org”.	`string`	-	-	No
`--test-upstream-cluster`	Name of an existing configured cluster to use as the test upstream. The cluster must be configured via —cluster, —cluster-insecure, or —cluster-json. Mutually exclusive with —test-upstream-host.	`string`	-	-	No
`--docker`	Run Envoy as a Docker container instead of using func-e.	`bool`	`false`	`BOE_RUN_DOCKER`	No
`--pull`	Pull policy for the BOE Docker image (missing, always, never). Only applicable when running with —docker.	`string`	`missing`	-	No
`--docker-image-version`	Override the BOE Docker image tag to use when running with —docker. By default, the image version matches the BOE version.	`string`	-	-	No