Skip to content

Install

You can install the pre-compiled binary (in several different ways), use Docker or compile from source.

Below you can find the steps for each of them.

Install the pre-compiled binary

Homebrew

brew install FriendsOfShopware/tap/shopware-cli

Debian/Ubuntu — APT based Linux

curl -1sLf \
  'https://dl.cloudsmith.io/public/friendsofshopware/stable/setup.deb.sh' \
  | sudo -E bash
sudo apt install shopware-cli

Fedora/CentOS/SUSE/RedHat — YUM based Linux

curl -1sLf \
  'https://dl.cloudsmith.io/public/friendsofshopware/stable/setup.rpm.sh' \
  | sudo -E bash
sudo dnf install shopware-cli

Alpine — APK based Linux

sudo apk add --no-cache bash
curl -1sLf \
  'https://dl.cloudsmith.io/public/friendsofshopware/stable/setup.alpine.sh' \
  | sudo -E bash
sudo apk add --no-cache shopware-cli

Archlinux User Repository (AUR)

yay -S shopware-cli-bin

Manually: deb,rpm apt packages

Download the .deb, .rpm or .apk packages from the releases page and install them with the appropriate tools.

Nix

nix-env -iA nixpkgs.shopware-cli

Devenv

{ pkgs, ... }: {
  packages = [ pkgs.shopware-cli ];
}

GitHub Codespaces

{
    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
    "features": {
        "ghcr.io/shyim/devcontainers-features/shopware-cli:latest": {}
    }
}

GitHub Action

using Shopware CLI Action

- name: Install shopware-cli
  uses: FriendsOfShopware/shopware-cli-action@v1
  env:
    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

go install

go install github.com/FriendsOfShopware/shopware-cli@latest

ddev

Add a file .ddev\web-build\Dockerfile.shopware-cli

# .ddev/.web-build/Dockerfile.shopware-cli
RUN curl -1sLf 'https://dl.cloudsmith.io/public/friendsofshopware/stable/setup.deb.sh' | sudo -E bash \
  && apt install shopware-cli

manually

Download the pre-compiled binaries from the releases page and copy them to the desired location.

Running with Docker

You can also use it within a Docker container. To do that, you'll need to execute something more-or-less like the examples below.

Registries:

Example usage:

Builds assets of an extension

docker run \
    --rm \
    -v $(pwd):$(pwd) \
    -w $(pwd) \
    -u $(id -u) \
    ghcr.io/friendsofshopware/shopware-cli \
    extension build FroshPlatformAdminer

You can verify the image with cosign:

cosign verify ghcr.io/friendsofshopware/shopware-cli \
  --certificate-identity 'https://github.com/FriendsOfShopware/shopware-cli/.github/workflows/release.yml@refs/tags/0.1.69' \
  --certificate-oidc-issuer 'https://token.actions.githubusercontent.com'

Hint: You have to adjust the version inside the certificate-identity

Compiling from source

If you just want to build from source for whatever reason, follow these steps:

clone:

git clone https://github.com/FriendsOfShopware/shopware-cli
cd shopware-cli

get the dependencies:

go mod tidy

build:

go build -o shopware-cli .

verify it works:

./shopware-cli --version