Skip to content

sdk broker cloud

Overview

Set the SDK broker configuration to point to a 'Quix Cloud' broker

Aliases: cloud, disable

Usage:

quix sdk broker cloud [options]

Options:

  • --workspace-id <workspace-id> : The environment to use if your SDK broker configuration is set to Quix Cloud
  • --env-file-name <env-file-name> : Set the name of the environment file [default: .env]
  • --directory <directory> : Base directory (defaults to current directory)
  • --update : Update '.env' files of all the applications with the current SDK broker configuration

How It Works

The quix sdk broker cloud command configures the SDK broker configuration to use the one in your Quix Cloud environment. This ensures that your local development setup uses the same broker as your Quix Cloud environment, which can be helpful for consistent testing and debugging.

Example Usage

To set the SDK broker configuration to the one in your Quix Cloud environment, use the following command:

$ quix sdk broker cloud

If the default environment ID is set, you will see the following message:

✓ SDK broker configuration: Quix Cloud (your-env-id)

No Default Environment ID Set

If no default environment ID is set, you will see the following message:

✓ SDK broker configuration: Quix Cloud (! Not set)

Tip

You can set the default environment using the quix use command.