Developing with Spryker SDK

Edit on GitHub

To install Spryker SDK for your development needs, clone the project and export SPRYKER_SDK_ENV with the dev environment, then create an alias:

git clone && \
cd sdk; \
PATH_TO_SDK=$(pwd) && \
if [ -e ~/.zshrc ]; then \
  echo 'export SPRYKER_SDK_ENV=dev' >> ~/.zshrc && \
  echo 'alias spryker-sdk="$PATH_TO_SDK/bin/"' >> ~/.zshrc && \
  source ~/.zshrc; \
else \
  echo 'export SPRYKER_SDK_ENV=dev' >> ~/.bashrc && \
  echo 'alias spryker-sdk="'$PATH_TO_SDK'/bin/"' >> ~/.bashrc && \
  source ~/.bashrc; \
fi; \
git describe --abbrev=0 --tags > VERSION; \
spryker-sdk --mode=docker sdk --install

Using Spryker SDK

  • Run a task or a command:
spryker-sdk <task|command>
  • To debug a task or a command, make sure the server name in IDE is spryker-sdk and run the following command:
spryker-sdk --mode=debug {TASK | COMMAND}
  • Run Spryker SDK in the production environment:
SPRYKER_SDK_ENV=prod spryker-sdk {TASK | COMMAND}
  • Run any command inside the docker container:
spryker-sdk --mode=docker "{COMMAND}"

spryker-sdk --mode=docker "cd /data && composer cs-check"
  • Jump into the docker container:
spryker-sdk --mode=docker /bin/bash

SDK helper

To get the list of useful commands, shortcuts, and aliases, run the SDK helper:

spryker-sdk --mode=docker sdk --help

Manage the project configuration

For details on the project configuration management, see the Symfony configuration docs.

Troubleshooting issues with the Docker container

If you face the following issues:

  • pulling the container from the Docker registry,
  • file permissions and ownership on files created by the SDK,

you can build your own container from SDK sources. Refer to Building flavored Spryker SDKs for details.