Run a PHP debugger
This topic discusses how to run a PHP debugger using Xdebug as an example.
- Log in to your local development system, or switch to, the Magento file system owner.
- Change to a directory to which the Magento file system owner has write access.
Enter the following command in a terminal to log in to your project:
List your projects. With the project ID, you can complete additional commands.
If necessary, clone the project to your local. You should have cloned when setting up your local development workspace.
magento-cloud project:get <project ID>
- Change to a project directory. For example,
List environments in the project. Every environment includes an active Git branch of your code, database, environment variables, configurations, and services.
magento-cloud environment:listdisplays environment hierarchies whereas
git branchdisplays does not. If you have any nested environments, use
magento-cloud environment:listto see the full list.
Fetch origin branches to get the latest code:
git fetch origin
Check out, or switch to, a specific branch and environment. Git commands only checkout the Git branch. The Magento Cloud command also switches to the active environment.
magento-cloud environment:checkout <environment ID>
To create a new environment, use
magento-cloud environment:branch <environment name> <parent environment ID>
Pull any updated code to your local for the environment ID (which is the Git branch):
git pull origin <environment ID>
Create a snapshot of the environment as a backup:
magento-cloud snapshot:create -e <environment ID>
Set up Xdebug
To set up Xdebug:
.magento.app.yamlin a text editor.
An example follows:
runtime: extensions: - mcrypt - redis - xsl - json - xdebug
- Save your changes to
.magento.app.yamland exit the text editor.
Add, commit, and push the changes to redeploy the environment:
git add -A git commit -m "Add xdebug" git push origin <environment ID>
Get the environment’s SSH URL:
magento-cloud environment:ssh --pipe -e <environment ID>
To use Xdebug, SSH to the environment as follows:
ssh -R <xdebug listen port>:<host>:<xdebug listen port> <SSH URL>
ssh -R 9000:localhost:9000 pwga8A0bhuk7ofirstname.lastname@example.org