streambed

help

Description

Show the help screen for streambed

Usage

streambed help

login

Description

Login as a user by supplying a username and password. Upon successful login, a token will be stored in $HOME/.streambed-cli/token and used for subsequent requests

Usage

streambed login [<username>]

Arguments

Name Description
username Optional. When provided, only the password will be prompted for over stdin

logout

Description

Logout, removing the locally stored token.

Usage

streambed logout

mqtt add up

Description

Add/Replace an MQTT upstream route. This configures data to flow from an MQTT topic to a streambed topic

Usage

streambed mqtt add up <id> <event-topic> <mqtt-event-topic> [--secret-path <path>] [--data-is-binary]

Arguments

Name Description
id An id to identify this route
event-topic The streambed topic that MQTT data should be stored in
mqtt-event-topic The MQTT topic to subscribe to for data

Flags

Name Description
–data-is-binary Provides a secret to decrypt data tailed from the event-topic

Options

Name Description
–secret-path Provides a secret to decrypt data tailed from the event-topic

mqtt add down

Add/Replace an MQTT downstream route. This configures data to flow from a streambed topic into an MQTT topic

Usage

streambed mqtt add down <id> <mqtt-command-topic> <command-topic> [--secret-path <path>] [--data-is-binary]

Arguments

Name Description
id An id to identify this route
mqtt-command-topic The MQTT topic to store data in
command-topic The streambed topic to subscribe to for data

Flags

Name Description
–data-is-binary Provides a secret to decrypt data tailed from the event-topic

Options

Name Description
–secret-path Provides a secret to decrypt data tailed from the event-topic

mqtt help

Description

Show the help screen for streambed mqtt

Usage

streambed mqtt help

mqtt ls

List all configured MQTT routes, both upstream and downstream

Usage

streambed mqtt ls

Arguments

Name Description
id Optional. If specified, only topics with the specified id will be listed

streambed secret add

Description

Add or replace a secret.

Usage

streambed secret add <path> <value>

Arguments

Name Description
path The path of the secret
value The value of the secret

streambed secret help

Description

Show the help screen for streambed secret

Usage

streambed secret help

streambed secret rm

Description

Remove a secret given its path

Usage

streambed secret rm <path>

Arguments

Name Description
path The path of the secret to remove

streambed user add

Description

Add or replace a user. This command will prompt for the user’s password twice

Usage

streambed user add <username>

Arguments

Name Description
username The username for the user that is being confured

streambed user help

Description

Show the help screen for streambed user

Usage

streambed user help

streambed user ls

Description

List a user by username

Arguments

Name Description
username The username of the user to list

Usage

streambed user ls <username>

streambed user rm

Description

Remove a user by username

Usage

streambed user rm <username>

Arguments

Name Description
username The username of the user to remove

Environment Configuration

The following flags are available be used to configure the streambed command for the target environment:

Name Environment Variable Description
–control-center-host CONTROL_CENTER_HOST Host for control-center service
–control-center-port CONTROL_CENTER_PORT Port for control-center service
–control-center-scheme CONTROL_CENTER_SCHEME Scheme for control-center service
–streambed-mqtt-gateway-host STREAMBED_MQTT_GATEWAY_HOST Host for streambed-mqtt-gateway service
–streambed-mqtt-gateway-port STREAMBED_MQTT_GATEWAY_PORT Port for streambed-mqtt-gateway service
–streambed-mqtt-gateway-scheme STREAMBED_MQTT_GATEWAY_SCHEME Scheme for streambed-mqtt-gateway service
–storage-dir STORAGE_DIR Directory to store CLI data in. Defaults to ~/HOME/.streambed-cli