The Developer Tools is a Command Line Interface (CLI) designed to streamline the development, testing, and deployment processes for Enterprise environments and Prestashop modules. These tools are here to make your work more efficient, consistent, and reliable.
The tools provide a unified platform to manage various aspects of your development workflow.
By automating repetitive tasks and simplifying complex processes, these tools aim to boost productivity and reduce the potential for human error.
From cloning shop files and dumping databases to deploying local environments and ensuring Prestashop compliance, the Enterprise Developer Tools are your go-to solution for managing Enterprise environnement and Prestashop modules.
Enterprise Developer Tools is a comprehensive Command Line Interface (CLI) designed to streamline the development, testing, and deployment of Enterprise environments and Prestashop modules.
It aims to enhance productivity by automating repetitive tasks and providing a unified interface for managing complex workflows.
Enterprise Developer Tools provides a robust set of features to support Enterprise environments and Prestashop module development:
Enterprise Developer Tools can be used in various scenarios, including:
Latest Docker for Ubuntu, or Docker Desktop for Windows/Macos
Latest Git
Prestashop Enterprise Platform account
SSH Key registered to Gitlab
(Optional) XDebug
(Optional) Ngrok free account
Open a terminal and download binary:
$ wget "https://assets.prestashop3.com/enterprise/tools/ubuntu/ps-enterprise.zip" && unzip ps-enterprise.zip && rm ps-enterprise.zip
Install application user wide:
$ ./ps-enterprise install
Restart terminal and check ps-enterprise version
$ ps-enterprise -v
Open a terminal and download binary:
$ curl -O "https://assets.prestashop3.com/enterprise/tools/macos/ps-enterprise.zip" && unzip ps-enterprise.zip && rm ps-enterprise.zip
Install application user wide:
$ ./ps-enterprise install
Restart terminal and check ps-enterprise version
$ ps-enterprise -v
Open Powershell and run this snippet to download binary:
Invoke-WebRequest -Uri "https://assets.prestashop3.com/enterprise/tools/windows/ps-enterprise.zip" `
-OutFile "ps-enterprise.zip"
Expand-Archive -Path "ps-enterprise.zip" `
-DestinationPath (Get-Location) -Force
Remove-Item -Path "ps-enterprise.zip"
Install application user wide:
$ ./ps-enterprise.exe install
Restart Powershell and check ps-enterprise version
$ ps-enterprise.exe -v
From the folder where you want to work, run :
$ ps-enterprise
By default, running CLI without any command name will pass through all required commands
to get a local environment fully running: auth, config, clone, remote-dump, patch, stop, start, log
auth and config commands once, only when settings are not complete.clone if no shop file exist.remote-dump and patch if any file is missing.stop then start local environment.log command to watch local environment logs.| flag | description | example |
|---|---|---|
-h, --help |
Show help information instead of running current command. | --help |
-c, --clean |
Run clean command first. |
--clean |
auth command and force mode enabled to all commands with -f flag available.ps-enterprise -u john.doe@email.com --force $ ps-enterprise <command>
Run in a shell, replacing <command> with command name.
Initiates the authentication process with the Prestashop Enterprise Platform.
This command ensures that your local environment can securely communicate with the Prestashop services.
It supports One-Time Password (OTP) authentication, although email OTP is not supported.
$ ps-enterprise auth
| flag | description | example |
|---|---|---|
-u, --user |
Specify an user email to avoid to input it manually. | --user john.doe@prestashop.com |
-f, --force |
Force to override existing authentication configuration. | -f |
Configures the necessary settings for your local environment.
This command allows you to select the platform project and environment you wish to work with, configure the public ngrok domain to access your local shop, and set up local environment debug settings.
This ensures that your local setup is tailored to match the production environment closely.
$ ps-enterprise config
| flag | description | example |
|---|---|---|
-f, --force |
Force to override existing configuration. | -f |
Clones the current deployed version of the project from the target environment to your local machine.
This command ensures that you have the latest code and configurations for development and testing purposes.
$ ps-enterprise clone
| flag | description | example |
|---|---|---|
-f, --force |
Force to override existing local version without confirmation. | -f |
Creates a dump of the remote environment’s database. This command ensures that you have a backup of the Enterprise remote environment database for testing and debugging locally.
./tmp/dump.sql.$ ps-enterprise remote-dump
| flag | description | example |
|---|---|---|
-o, --output |
Specify a new path for dump file. | --output /home/jdoe/dump.sql |
Updates deployed configuration and database settings to match the local environment.
This command ensures that your local setup functions correctly.
$ ps-enterprise patch
Stops the running local environment.
This command is useful for shutting down the environment when it is no longer needed or before making significant changes. It ensures that all processes are terminated cleanly.
$ ps-enterprise stop
Starts or restarts the local environment.
This command ensures that the environment is up and running, ready for development or testing.
If the environment is already running, it will be restarted to apply any changes made.
$ ps-enterprise start
Monitors the logs of the running local environment.
This command allows you to select which application’s logs should be displayed, providing insights into the environment’s performance and any potential issues.
$ ps-enterprise log
Cleans up local environment files and resets configurations.
This command deletes local files and settings.
It is useful for resetting the environment to a clean state.
$ ps-enterprise clean
| flag | description | example |
|---|---|---|
-f, --force |
Force to clean everything without confirmation. | -f |
Checks the compliance of a Prestashop module against Prestashop standards.
This command uses the Prestashop Compliance to analyze module files and identify errors.
It ensures that your modules meet the required quality criteria.
$ ps-enterprise compliance <module>
Replace <module> with module name to check compliance.
Module name can be partial, it refers to module root directory name.
If more than one module includes module name, ask to select one.
Module name is optional, if not specified, ask to select one from all modules.
Execute a shell command inside one or more containers from your local environment.
Useful to run maintenance scripts, inspect files, or open an interactive shell.
sh, but can be overridden with --shell=bash.--interactive.$ ps-enterprise exec <command>
Replace <command> with shell command to execute on local shop.
| flag | description | example |
|---|---|---|
--shell=<shell> |
Use a specific shell inside the container (sh by default) |
--shell=bash |
--interactive |
Open an interactive shell session in the matched container | --interactive |