help

The help commands lists all the available functions of the BrowserUp Command Line Util.

browserup help
============================
BrowserUp Command Line Util
============================

Commands:
  browserup deprovision     # Deprovision the BrowserUp app.
  browserup help [COMMAND]  # Describe available commands or one specific command
  browserup new [examples]  # Generates a test config w/ examples. postman,curl,java,ruby,python,playwright-js,playwright-python,selenium-ruby,selenium-java,...
  browserup provision       # Provision a BrowserUp for running the test.
  browserup report          # Open an HTML report of most recent load test.
  browserup start           # Run a load scenario. Provisions local (default) or remote BrowserUp app. Builds and uploads all items in scenario.
  browserup status          # Show the status of a load test scenario on a remote private BrowserUp cluster.
  browserup stop            # Stop a load test scenario on a remote private BrowserUp cluster.
  browserup upload_license  # Upload License.
  browserup verify COMMAND  # Verify a command string runs in our container, and produced traffic in our HAR (traffic collection).
  browserup version         # Show the installed version of this application.

Options:
  v, [--verbose], [--no-verbose]  # Enable or disable verbose output logging. Disabled by default.
				  # Or set the $BROWSERUP_CLI_VERBOSE environment variable.
  c, [--config=CONFIG]            # Path to browserup.yaml configuration file.
                                  # Default: /Users/ebeland/apps/browserup/cli/browserup.yaml
  a, [--api-token=API_TOKEN]      # Your BrowserUp account API access token.
				  # Or set the $BROWSERUP_API_TOKEN environment variable.
				  # Required for remote tests. Optional for local tests.


Local Docker ✓

Detailed Command-specific Help

For detailed help on a single command, pass it as an argument to the help command

browserup help start
=================================
BrowserUp Command Line Util
=================================

Usage:
  browserup start

Options:
      [--scenario=SCENARIO]                        # A valid scenario ID from the browserup.yaml configuration file. The first scenario found is used by default.
      [--provision], [--no-provision]              # If no BrowserUp app is provisioned, provision one before starting the test.
      [--cluster-type=CLUSTER_TYPE]                # Cluster type, either 'local' or 'aws'.
                                                   # Default: local
      [--region=REGION]                            # AWS Region
                                                   # Default: us-east-2
      [--instance=INSTANCE]                        # AWS instance type
                                                   # Default: m5a.xlarge
      [--admin-emails=one two three]               # Space separated list of emails to receive system notifications
      [--key-pair=KEY_PAIR]                        # Optional AWS Key Pair name to use for ECS cluster.
      [--create-key-pair], [--no-create-key-pair]  # Optional flag to create AWS Key Pair for ECS cluster and save it. Ignored in case key_pair is provided.
                                                   # Default: true
  v, [--verbose], [--no-verbose]                   # Enable or disable verbose output logging. Disabled by default.
				  # Or set the $BROWSERUP_CLI_VERBOSE environment variable.
  c, [--config=CONFIG]                             # Path to browserup.yaml configuration file.
                                                   # Default: /Users/ebeland/apps/browserup/cli/scaffolds/python/browserup.yaml
  a, [--api-token=API_TOKEN]                       # Your BrowserUp account API access token.
				  # Or set the $BROWSERUP_API_TOKEN environment variable.
				  # Required for remote tests. Optional for local tests.

Run a load scenario. Provisions local (default) or AWS BrowserUp app. Builds and uploads all items in scenario.

Local Docker ✓