SwissUpLabs

https://docs.swissuplabs.com
Admin
SwissUpLabs provides a comprehensive suite of themes, extensions, and performance optimization tools...
Tokens:424,830
Snippets:5,560
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Marketplace Module

Source: https://docs.swissuplabs.com/m2/argento/installation/manual-update

Installs the SwissUp Marketplace module and runs the setup upgrade command.

```bash
composer require swissup/module-marketplace &&\
bin/magento setup:upgrade --safe-mode=1
```

--------------------------------

### Install Subscribe at Checkout Extension

Source: https://docs.swissuplabs.com/m2/extensions/subscribe-at-checkout/installation/composer

Execute these commands to install the extension and perform the necessary Magento setup tasks.

```bash
composer require swissup/product-subscribe-at-checkout &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Advanced Package Installation

Source: https://docs.swissuplabs.com/m2/extensions/marketplace/cli

Examples of running specific module installers with store filtering or skipping specific installers.

```bash
# Run cms-page and config installers only for specified store
bin/magento marketplace:package:install <package> store=ID cms-page config

# Run all except cms-page installer for specified store
bin/magento marketplace:package:install <package> store=ID skip-cms-page
```

--------------------------------

### Install Helpdesk Extension

Source: https://docs.swissuplabs.com/m2/extensions/helpdesk/installation/composer

Execute these commands to install the Helpdesk module and perform the necessary Magento setup tasks.

```bash
composer require swissup/helpdesk &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Highlight Extension

Source: https://docs.swissuplabs.com/m2/extensions/highlight/installation/marketplace

Execute these commands to install the Highlight extension and perform necessary Magento setup tasks.

```bash
_content_copy_composer require swissup/highlight &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Highlight Module

Source: https://docs.swissuplabs.com/m2/extensions/highlight/installation/composer

Execute these commands to install the Highlight module and perform necessary Magento setup tasks.

```bash
composer require swissup/highlight &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Askit Module

Source: https://docs.swissuplabs.com/m2/extensions/askit/installation/composer

Execute these commands to install the Askit module and perform necessary Magento setup tasks.

```bash
composer require swissup/askit &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Breeze Content Builder

Source: https://docs.swissuplabs.com/m2/extensions/breeze-content-builder/installation/composer

Execute these commands to install the extension and perform necessary Magento setup tasks.

```bash
composer require swissup/breeze-content-builder &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Compare Module

Source: https://docs.swissuplabs.com/m2/extensions/compare/installation

Finalizes the installation by requiring the module and running Magento setup commands.

```bash
composer require swissup/compare &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Testimonials Extension

Source: https://docs.swissuplabs.com/m2/extensions/hyva-testimonials/installation/composer

Execute these commands to install the Testimonials module and perform necessary Magento setup tasks.

```bash
composer require swissup/testimonials &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install FireCheckout Module

Source: https://docs.swissuplabs.com/m2/extensions/firecheckout/installation/marketplace

Execute these commands to install the FireCheckout package and perform necessary Magento setup tasks.

```bash
composer require swissup/firecheckout &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy &&\
bin/magento marketplace:package:install swissup/firecheckout
```

--------------------------------

### Install EasyCatalogImages Module

Source: https://docs.swissuplabs.com/m2/extensions/easycatalogimages/installation/composer

Execute these commands to install the EasyCatalogImages module and perform necessary Magento setup tasks.

```bash
composer require swissup/easycatalogimg &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Knowledge Base Module

Source: https://docs.swissuplabs.com/m2/extensions/knowledgebase/installation/composer

Execute these commands to install the Knowledge Base module and perform necessary Magento setup tasks.

```bash
composer require swissup/knowledge-base &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install AMP Extension

Source: https://docs.swissuplabs.com/m2/extensions/amp/installation/composer

Execute these commands to install the AMP extension and perform necessary Magento setup tasks.

```bash
composer require swissup/amp &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f  &&\
bin/magento marketplace:package:install swissup/amp
```

--------------------------------

### Install Hyva AskIt module

Source: https://docs.swissuplabs.com/m2/extensions/hyva-askit/installation/composer

Execute these commands to install the Hyva AskIt module and perform the necessary Magento setup tasks.

```bash
composer require swissup/hyva-askit &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Checkout Consumer Rights Module

Source: https://docs.swissuplabs.com/m2/extensions/checkout-consumer-rights/installation/composer

Execute these commands to install the module and perform the necessary Magento setup tasks.

```bash
composer require swissup/checkout-consumer-rights &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Example Settings Configuration

Source: https://docs.swissuplabs.com/m2/extensions/breeze-theme-editor/theme-developer-guide

A sample object demonstrating various setting keys and their assigned values.

```json
{
  "colors.primary_color": "#1a1a1a",
  "typography.font_family": "Roboto",
  "layout.sidebar_width": "250px",
  "spacing.container_padding": "2rem"
}
```

--------------------------------

### Initialize Shopware Project

Source: https://docs.swissuplabs.com/shopware/dev

Creates a new Shopware production project and navigates into the directory.

```bash
_content_copy_ composer create-project shopware/production shopware
```

```bash
_content_copy_cd shopware
```

--------------------------------

### Install NavigationPro Module

Source: https://docs.swissuplabs.com/m2/extensions/navigationpro/installation/manual

Finalizes the installation by requiring the package and running Magento setup commands.

```bash
composer require swissup/navigationpro &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy &&\
bin/magento marketplace:package:install swissup/navigationpro
```

--------------------------------

### Install LightboxPro Module

Source: https://docs.swissuplabs.com/m2/extensions/lightboxpro/installation/manual

Finalizes the installation by requiring the module and running Magento setup commands.

```bash
composer require swissup/lightboxpro &&
bin/magento setup:upgrade --safe-mode=1 &&
bin/magento setup:di:compile &&
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Demo Data

Source: https://docs.swissuplabs.com/shopware/dev

Installs dev-tools and populates the framework with demo data.

```bash
_content_copy_composer require shopware/dev-tools
symfony console framework:demodata
```

--------------------------------

### Install Order Attachments Module

Source: https://docs.swissuplabs.com/m2/extensions/order-attachments/installation/manual

Finalizes the installation by requiring the module and running Magento setup commands.

```bash
composer require swissup/product-orderattachment &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Highlight Module

Source: https://docs.swissuplabs.com/m2/extensions/highlight/installation/manual

Run the final installation commands to register and compile the Highlight module.

```bash
composer require swissup/highlight &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Checkout Registration Module

Source: https://docs.swissuplabs.com/m2/extensions/checkout-registration/installation/manual

Finalizes the installation by requiring the module and running Magento setup commands.

```bash
composer require swissup/checkout-registration &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Ajax Layered Navigation

Source: https://docs.swissuplabs.com/m2/extensions/ajaxlayerednavigation/installation/manual

Finalizes the installation by requiring the module and running Magento setup commands.

```bash
composer require swissup/ajaxlayerednavigation &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Address Validation Module

Source: https://docs.swissuplabs.com/m2/extensions/address-validation/installation/manual

Finalizes the installation by requiring the module and running Magento setup commands.

```bash
composer require swissup/address-validation &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Configure installer commands

Source: https://docs.swissuplabs.com/m2/extensions/marketplace/devdocs/installer

Implement the core installation logic using command classes and data mapping.

```xml
<commands>
    <command class="Swissup\Marketplace\Installer\Command\Config">
        <data>
            <item name="mypackage/general/enabled">1</item>
            <item name="mypackage/general/option1" helper="Swissup\Marketplace\Installer\Helper\Request::getData">
                <param name="key">select_field_name1</param>
            </item>
            <item name="mypackage/general/option2" helper="Swissup\Marketplace\Installer\Helper\Request::getData">
                <param name="key">select_field_name2</param>
            </item>
            <item name="mypackage/general/option3" helper="Swissup\Marketplace\Installer\Helper\Request::getData">
                <param name="key">text_field_name</param>
            </item>
        </data>
    </command>
<commands>
```

--------------------------------

### Install Speculation Rules Module

Source: https://docs.swissuplabs.com/m2/extensions/speculation-rules/installation/composer

Execute these commands to install the module and perform the necessary Magento setup tasks.

```bash
composer require swissup/module-speculation-rules &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install LightboxPro extension

Source: https://docs.swissuplabs.com/m2/extensions/lightboxpro/installation/composer

Execute these commands to install the LightboxPro package and perform necessary Magento setup tasks.

```bash
composer require swissup/lightboxpro &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f
```

--------------------------------

### Implement Help Text

Source: https://docs.swissuplabs.com/m2/extensions/breeze-theme-editor/theme-developer-guide

Provide descriptions and detailed help text to guide users through theme settings.

```json
{
  "description": "Main brand color for buttons and links"
}
```

```json
{
  "help_text": "This color is used for:\n- Primary buttons (Add to Cart, Checkout)\n- Text links\n- Focus states\n- Hover effects"
}
```

```json
{
  "help_text": "Accepts values like: 10px, 1rem, 2em, 5%"
}
```

--------------------------------

### Fast Enable and Deploy

Source: https://docs.swissuplabs.com/m2/extensions/pagespeed/installation

Alternative commands to install the package via the marketplace installer and deploy static content.

```bash
_content_copy_bin/magento marketplace:package:install swissup/module-pagespeed
bin/magento setup:static-content:deploy [-f]
```

--------------------------------

### Install Navigation Pro Extension

Source: https://docs.swissuplabs.com/m2/extensions/navigationpro/installation/composer

Execute these commands to install the Navigation Pro package after the Marketplace module is configured.

```bash
_content_copy_composer require swissup/navigationpro &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f  &&\
bin/magento marketplace:package:install swissup/navigationpro
```

--------------------------------

### Prepare and Run WebP Conversion

Source: https://docs.swissuplabs.com/shopware/pagespeed

Install the required cwebp binary and verify the environment before running the conversion command.

```bash
sudo apt-get install cwebp
symfony console swissup:media:web --info
```

```bash
symfony console swissup:media:web
```

--------------------------------

### Install Marketplace module

Source: https://docs.swissuplabs.com/m2/argento/installation/marketplace

Run these commands to install the Marketplace module and enable the Magento channel.

```bash
_content_copy_composer require swissup/module-marketplace &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento marketplace:channel:enable magento
```

--------------------------------

### Install GeoIP Module

Source: https://docs.swissuplabs.com/m2/extensions/geo-address-ip/installation/marketplace

Execute these commands to install the GeoIP module and perform necessary Magento setup tasks.

```bash
composer require swissup/geoip &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Configure Color Format Options

Source: https://docs.swissuplabs.com/m2/extensions/breeze-theme-editor/theme-developer-guide

Examples showing how to set color output formats to hex, rgb, or auto.

```json
{
  "id": "text_color",
  "type": "color",
  "default": "#111827",
  "property": "--text-color",
  "format": "hex"
}
```

```css
:root {
  --text-color: #111827;
}
```

```json
{
  "id": "text_color",
  "type": "color",
  "default": "#111827",
  "property": "--text-color",
  "format": "rgb"
}
```

```css
:root {
  --text-color: 17, 24, 39;  /* RGB format */
}
```

```json
{
  "id": "text_color",
  "type": "color",
  "default": "255, 0, 0",
  "property": "--text-color",
  "format": "auto"
}
```

--------------------------------

### Install AMP Extension

Source: https://docs.swissuplabs.com/m2/extensions/amp/installation/marketplace

Execute these commands to install the AMP extension after the Marketplace module is set up.

```bash
composer require swissup/amp &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy &&\
bin/magento marketplace:package:install swissup/amp
```

--------------------------------

### Install Featured Attributes Module

Source: https://docs.swissuplabs.com/m2/extensions/featured-attributes/installation

Install the Featured Attributes module and perform the necessary Magento setup tasks.

```bash
composer require swissup/featured-attributes &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy
```

--------------------------------

### Install Email Extension

Source: https://docs.swissuplabs.com/m2/extensions/email/installation/composer

Execute these commands to install the Email extension and perform necessary Magento setup tasks.

```bash
composer require swissup/email &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install EasyTabs Extension

Source: https://docs.swissuplabs.com/m2/extensions/easytabs/installation/composer

Execute these commands to install the EasyTabs extension and perform necessary Magento setup tasks.

```bash
composer require swissup/easytabs &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Marketplace Module

Source: https://docs.swissuplabs.com/m2/argento/installation/composer-update

Installs the SwissUpLabs Marketplace module and enables the required channel.

```bash
composer require swissup/module-marketplace &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento marketplace:channel:enable swissuplabs
```

--------------------------------

### Install EasySlider Extension

Source: https://docs.swissuplabs.com/m2/extensions/easyslider/installation/composer

Execute these commands to install the EasySlider module and perform the necessary Magento setup tasks.

```bash
composer require swissup/easy-slide &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install EasyBanners Module

Source: https://docs.swissuplabs.com/m2/extensions/easybanners/installation/composer

Execute these commands to install the EasyBanners module and perform necessary Magento setup tasks.

```bash
composer require swissup/easybanner &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### View WebP conversion command help

Source: https://docs.swissuplabs.com/m2/extensions/webp/quickstart

Display the help documentation and available options for the WebP conversion command.

```bash
bin/magento swissup:webp:convert -h
```

--------------------------------

### Define Installer Configuration in installer.xml

Source: https://docs.swissuplabs.com/m2/extensions/marketplace/devdocs/installer

This XML file defines the target package, user input fields, and commands to execute during installation.

```xml
<?xml version="1.0"?>
<config>
    <!-- Run installer for these packages: -->
    <packages>
        <package>my/package</package>
    </packages>

    <!-- Declare fields to ask during installation (Optional): -->
    <fields>
        <field name="my_package_theme" title="Select Mypackage Theme">
            <option title="Light">light</option>
            <option title="Dark">dark</option>
        </field>
    </fields>

    <!-- Declare commands to run: -->
    <commands>
        <command class="Swissup\Marketplace\Installer\Command\Config">
            <data>
                <item name="mypackage/general/enabled">1</item>
                <item name="mypackage/general/theme" helper="Swissup\Marketplace\Installer\Helper\Request::getData">
                    <param name="key">my_package_theme</param>
                </item>
            </data>
        </command>
    </commands>
</config>
```

--------------------------------

### Configure Basic Theme Settings

Source: https://docs.swissuplabs.com/m2/extensions/breeze-theme-editor/theme-developer-guide

Example JSON configuration for defining theme sections and settings, such as color pickers.

```json
{
  "version": "1.0",
  "sections": [
    {
      "id": "colors",
      "name": "Colors",
      "description": "Customize theme colors",
      "icon": "palette",
      "order": 1,
      "settings": [
        {
          "id": "primary_color",
          "label": "Primary Color",
          "type": "color",
          "default": "#1979c3",
          "property": "--primary-color",
          "description": "Main brand color"
        }
      ]
    }
  ]
}
```

--------------------------------

### Install ChatGPT Assistant via Composer

Source: https://docs.swissuplabs.com/shopware/chat-gpt-assistant

Use these commands in the Shopware root directory to add the repository, install the package, and refresh the plugin system.

```bash
cd <shopware_root>
composer config repositories.sw6-chat-gpt-assistant vcs git@github.com:swissup/sw6-chat-gpt-assistant.git
composer require swissup/sw6-chat-gpt-assistant:dev-master --prefer-source
symfony console plugin:refresh
symfony console plugin:install SwissupChatGptAssistant --activate
symfony console cache:clear
symfony run bin/build-administration.sh
```

--------------------------------

### Install Akismet Extension

Source: https://docs.swissuplabs.com/m2/extensions/akismet/installation/composer

Execute these commands to install the Akismet extension and perform the necessary Magento setup tasks.

```bash
composer require swissup/akismet &&\
bin/magento setup:upgrade --safe-mode=1 &&\
bin/magento setup:di:compile &&\
bin/magento setup:static-content:deploy -f 
```

--------------------------------

### Install Image Optimization Tools

Source: https://docs.swissuplabs.com/m2/extensions/pagespeed/quickstart

Install required system-level image optimization libraries via CLI.

```bash
  sudo apt-get install jpegoptim
  sudo apt-get install optipng
  sudo apt-get install pngquant
  sudo npm install -g svgo
  sudo apt-get install gifsicle
  sudo apt-get install webp
```
Tokens:
Raw