Skip to main content

Command Line

This guide documents how to run and debug the Breeze Agent via its launcher scripts.

Basic Usage

  • Linux/macOS: ./app.sh [options]
  • Windows: app.bat [options]

Options

  • -v, --verbose — force log to STDOUT and set info-level logging
  • -T, --no-timeout — disable execution timeout
  • --update-packages — refresh local packages cache before run

Examples

Run With the Current Configuration

cd /opt/breeze-agent && ./app.sh

Run in Verbose Mode With No Timeout

./app.sh -v -T

Update Packages and Run in Verbose Mode

./app.sh --update-packages --verbose

Exit Codes

  • 0 — success/normal termination
  • Non‑zero — configuration, permission, network, or certificate errors
  • Early exit (no code change) when another instance is running

Process Control (Linux/macOS)

  • PID file: app.pid in install directory
  • Prevents duplicate runs; removes stale PID when safe

Check or Stop a Stuck Process

ps aux | grep app.rb
kill "$(cat /opt/breeze-agent/app.pid)" || true
rm -f /opt/breeze-agent/app.pid

Configuration File

  • Path: etc/agent.conf (JSON)
  • Linux: /opt/breeze-agent/etc/agent.conf
  • Windows: C:\\Program Files\\Breeze\\etc\\agent.conf

See also: Config

Environment Variables

Set HTTP and HTTPS proxy environment variables so the application and related commands route network traffic through the specified proxy server.

export http_proxy=http://proxy.example.com:3128

Set the custom CA certificate path before Ruby starts:

export HTTP_CA_FILE=/path/to/custom-ca.pem

Windows equivalents go into C:\\Program Files\\Breeze\\app.bat.

Troubleshooting

Validate Configuration and Connectivity

cd /opt/breeze-agent && ./app.sh -vT

Refresh the Package Cache and Retry

./app.sh --update-packages -v