Skip to main content
Skip table of contents

Breeze 3.0 - Command Line Interface

Initialization

To add the Breeze environment variables to the shell, run the following command as root/Administrator:

  • Linux/macOS:

    CODE
    . /opt/cloudaware/breeze/bin/env.sh
    breeze help
  • Windows (Command Prompt):

    CODE
    call C:\\"Program Files"\\Cloudaware\\Breeze\\bin\\env.cmd
    breeze help

This command will:

  1. add the BREEZE_HOME_DIR environment variable

  2. add the path to the Ruby directory to the PATH environment variable

  3. load the Breeze configuration settings

  4. load Bash completions if enabled (for Bash only)

Synopsis

CODE
breeze <subcommand> [options]

Use breeze help <subcommand> for information on a specific subcommand.

Global options

--client-certificate <file> - path to the certificate

--client-private-key <file> - path to the private key

--color, --no-color - colorize log output

-d, --debug, --no-debug - debug mode

--home-dir <directory> - agent home directory

--log-file <file> - path to the log file

--server-url <url> - Breeze server URL

-v, --verbose, --no-verbose - verbose mode

Subcommands

env

Description

Shows Breeze environment variables.

Example

CODE
breeze env

help

Description

Describes available commands or one specific command.

Example

CODE
breeze help run

run

Description

Runs the Breeze agent.

Options

-l, --local-mode, --no-local-mode - local mode

-p, --plugin <plugin> - run only one plugin

-t, --timeout [seconds] - timeout

Examples

Runs the agent in verbose mode with no timeout:

CODE
breeze run -vt

Runs the agent without color output and specified log file:

CODE
breeze run --no-color --log-file /path/to/log/file

scheduler

Description

Configures the system scheduler service.

Subcommands

  • enable enables Breeze scheduled task

  • disable disables Breeze scheduled task

Examples

CODE
breeze scheduler enable --verbose
CODE
breeze scheduler disable

status

Description

Shows the agent status.

Options

--retries <number> - number of attempts to determine the status of the agent

Example

CODE
breeze status

troubleshoot

Description

Troubleshoots the agent.

Examples

CODE
breeze troubleshoot
CODE
breeze troubleshoot -v

upgrade

Description

Upgrades the agent.

Options

--to-version <version> - upgrade to a specific version

Examples

CODE
breeze upgrade
CODE
breeze upgrade --to-version 3.0.2

version

Description

Shows the agent version.

Example

CODE
breeze version
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.