spryker-sdk/sdk

The Spryker SDK aims to provide a single entry point to accelerate your productivity working with Spryker.

0.7.17 2024-12-17 12:35 UTC

Requires

• php: >=8.2
• composer-runtime-api: ^2.1
• ext-ctype: *
• ext-curl: *
• ext-iconv: *
• ext-json: *
• ext-pcre: *
• ext-pdo: *
• ext-phar: *
• ext-simplexml: *
• ext-sqlite3: *
• ext-xml: *
• composer/semver: ^3.4
• doctrine/doctrine-bundle: ^2.11
• doctrine/doctrine-migrations-bundle: ^3.3
• doctrine/migrations: ^3.5
• doctrine/orm: ^2.17
• ergebnis/json-printer: ^3.2
• guzzlehttp/guzzle: ^7.8
• laminas/laminas-filter: ^2.22
• laminas/laminas-stdlib: ^3.13
• m4tthumphrey/php-gitlab-api: ^11.12
• monolog/monolog: ^2.9
• nelmio/api-doc-bundle: ^4.12
• ondrejmirtes/better-reflection: 6.40.*
• phpbench/phpbench: ^1.2
• phpmd/phpmd: 2.15.*
• phpstan/phpstan: ^1.10
• psr/cache: ^1.0 || ^2.0 || ^3.0
• psr/log: ^1.0 || ^2.0 || ^3.0
• ramsey/uuid: ^3.9
• rector/rector: ^0.13
• spryker-sdk/acp: ^0.3.2
• spryker-sdk/async-api: ^0.3.2
• spryker-sdk/brancho: dev-master as 1.0.0
• spryker-sdk/composer-replace: dev-master as 1.0.0
• spryker-sdk/evaluator: ^0.2.0
• spryker-sdk/sdk-contracts: ^0.5.0
• spryker-sdk/security-checker: ^0.2.0
• spryker-sdk/spryk: ^0.4.7
• spryker-sdk/sync-api: ^0.1.1
• spryker-sdk/upgrader: ^0.3.12
• spryker/architecture-sniffer: ^0.5.7
• spryker/code-sniffer: ^0.17.18
• symfony/asset: ^6.0
• symfony/config: ^6.0
• symfony/console: ^6.0
• symfony/deprecation-contracts: ^2.5 || ^3.0
• symfony/dotenv: ^6.0
• symfony/event-dispatcher: ^6.0
• symfony/event-dispatcher-contracts: ^2.5 || ^3.0
• symfony/expression-language: ^6.0
• symfony/filesystem: ^6.0
• symfony/flex: ^1.21
• symfony/framework-bundle: ^6.0
• symfony/lock: ^6.0
• symfony/monolog-bundle: ^3.10
• symfony/process: ^6.0
• symfony/runtime: ^6.0
• symfony/serializer: ^6.0
• symfony/twig-bundle: ^6.0
• symfony/validator: ^6.0
• symfony/var-exporter: ^6.0
• symfony/workflow: ^6.0
• symfony/yaml: ^6.0
• vimeo/psalm: dev-master#03ee02c

Requires (Dev)

• codeception/codeception: ^5.1.2
• codeception/module-asserts: ^3.0
• codeception/module-cli: ^2.0
• codeception/module-filesystem: ^3.0
• codeception/module-phpbrowser: ^3.0
• codeception/module-rest: ^3.3
• codeception/module-symfony: ^3.2
• codeception/module-webdriver: ^4.0.1
• mikey179/vfsstream: ^1.6
• pavelmaksimov25/jsonpath: ^0.2
• phpunit/php-code-coverage: ^11.0
• phpunit/php-timer: ^7.0
• symfony/var-dumper: ^6.0

Suggests

• spryker-sdk/sdk-tasks-bundle: Provides a list of SDK tasks for the internal Spryker projects.

Conflicts

• symfony/symfony: *

proprietary

README

The Spryker SDK aims to provide a single entry point to accelerate your productivity working with Spryker. No matter if you want to validate existing code, implement new features with Spryker or go live with your project, the Spryker SDK provides you the tools to fulfill your mission faster and cut out the boring parts of the development, so you can focus developing exciting features for your business case.

Installation

• ensure auth file is available for composer (https://getcomposer.org/doc/articles/authentication-for-private-packages.md)
• ensure docker & docker-compose is installed
• Download the installer.sh from the latest release at https://github.com/spryker-sdk/sdk/releases
• run installer.sh </path/to/install/sdk/in>
• follow the installer's instructions.
• alias spryker-sdk should be set and SPRYKER_SDK_PATH env variable should be exported. If not check our troubleshooting doc.

Installation into the current dir:

PATH_TO_SDK=$(pwd) \
&& curl -fL github.com/spryker-sdk/sdk/releases/latest/download/installer.sh -O \
&& chmod +x installer.sh \
&& ./installer.sh "${PATH_TO_SDK}" \
&& rm -f installer.sh \
&& if [ -e ~/.zshrc ]; then source ~/.zshrc; else source ~/.bashrc; fi; \
echo "Current SDK version: $(spryker-sdk --version)"

Update

Can be executed from any directory. The path will be taken from the SPRYKER_SDK_PATH env variable

curl -fL github.com/spryker-sdk/sdk/releases/latest/download/installer.sh -O \
&& chmod +x installer.sh \
&& ./installer.sh --self-update \
&& rm -f installer.sh \
&& echo "Current SDK version: $(spryker-sdk --version)"

Getting started

To get an overview on the available capabilities of the Spryker SDK please run spryker-sdk list

Any task can be executed by running spryker-sdk <task-id> from project root folder. Using bin/consolespryker-sdk <task-id> -h will give a description on what options can be passed into the task.

Extending the SDK capabilities

Pleaser refer to the extension documentation for further information on how to extend the SDK. Extensions to the SDK should follow the SDK conventions. For maintaining an extension of the SDK please refer to the lifecycle management.

PhpStorm Command Line Tools

Please refer to the phpstorm integration documentation for further information on how to integrate the SDK to PhpStorm.

Running the SDK as a developer

Running the SDK in a development or debug mode is documented at development documentation