Shopmon CLI

A command-line tool for monitoring and managing Shopware applications with deployment telemetry.

Features

• Track deployment commands and their execution details to Shopmon monitoring service

Installation

Composer

composer require frosh/shopmon-cli

# Downloads on the fly shopmon-cli and executes the command
vendor/bin/shopmon-cli deploy -- <command>

Docker

COPY --from=ghcr.io/friendsofshopware/shopmon-cli:0.0.6 /shopmon-cli /usr/local/bin/shopmon-cli

Usage

Basic Usage

./shopmon-cli deploy -- <command>

Examples

# Execute a simple command
./shopmon-cli deploy -- vendor/bin/shopware-deployment-helper run

Environment Variables

• SHOPMON_BASE_URL: Override the default monitoring service URL (default: https://shopmon.fos.gg)
• SHOPMON_API_KEY: Authorization token for the monitoring service (required, sent as Bearer token)
• SHOPMON_ENVIRONMENT_ID: Environment ID the deployment belongs to (required; SHOPMON_SHOP_ID is still accepted as a legacy alias)
• SHOPMON_DEPLOYMENT_NAME: Custom name for the deployment (if not set, the server generates a random name)
• SHOPMON_DEPLOYMENT_VERSION_REFERENCE: Override the version reference (defaults to git rev-parse HEAD)

# With custom URL
SHOPMON_BASE_URL="http://localhost:8080" \
SHOPMON_API_KEY="your-secret-token" \
SHOPMON_ENVIRONMENT_ID="42" \
./shopmon-cli deploy -- vendor/bin/shopware-deployment-helper run

# Against shopmon.fos.gg
SHOPMON_API_KEY="your-secret-token" SHOPMON_ENVIRONMENT_ID="42" \
./shopmon-cli deploy -- vendor/bin/shopware-deployment-helper run

License

MIT