Using Developer Tools with ddev
Using Developer Tools with DDEV-Local¶
Developer Tools Built Into DDEV-Local¶
ddev describe to see the project information and services available for your project and how to access them.
Command-line Tools in the Containers¶
Hundreds of useful developer tools are included inside the containers. Any of these tools can be used via
ddev exec or
ddev ssh. A short listing is:
- MySQL Client (mysql) - Command-line interface for interacting with MySQL/MariaDB.
- Drush - Command-line shell and Unix scripting interface for Drupal.
- PHIVE - Command line tool for "PHAR Installation and Verification Environment"
- WP-CLI - Command-line tools for managing WordPress installations, available both as "wp" and as "wp-cli".
- npm and yarn
You can also add tools that are not provided by default using
webimage_extra_packages or a custom Dockerfile.
DDEV and Composer¶
ddev provides a built-in command to simplify use of Composer, the dependency manager for PHP, that allows a user to create and manage projects without having Composer installed on the host machine. Generally, executing any Composer command through DDEV is as simple as prepending the command with
ddev. DDEV will execute the command at the project root in the web container, passing (almost) all arguments and flags to Composer. To execute Composer in other directories within the container, use
ddev ssh or
ddev exec -d <dir>. For example:
ddev composer help
ddev composer require <package>
Additionally, Composer can be used to initialize new projects with
ddev composer create. This command supports limited argument and flag options, and will install a new project to the project root in
/var/www/html. The package and version arguments are required:
ddev composer create [<flags>] "<package>:<version>"
ddev composer create --no-dev "typo3/cms-base-distribution:^9"
To execute a fully-featured
composer create-project command, you can execute the command from within the container after executing
ddev ssh, or pass the full command to
ddev exec, like so:
ddev exec composer create-project ...
DDEV-Local uses composer version 2 by default. If you want to roll back to version 1,
ddev config --composer-version=1 && ddev start
If your composer.json is not in the project root, you'll need to provide the
-d argument expressing the in-container path to the directory where the composer.json is, for example,
ddev composer install -d /var/www/html/path/to/dir.
Note: if you run
ddev composer global require, (or run
composer global require inside the web container) the global packages will be installed in the in-container user's home directory ( ~/.composer) and will disappear on the next container restart, requiring rerun of the command. You may need an additional step of synchronizing created composer configuration and installed packages with the DDEV's homeadditions folder on the host.
Windows OS and
Both composer and Docker Desktop for Windows introduce quite complex filesystem workarounds. DDEV attempts to help you with each of them.
You generally don't have to worry about any of this, but it does keep things cleaner. Mostly just a few of the more complex TYPO3 projects have been affected.
- On Docker Desktop for Windows, symlinks are created in the container as "simulated symlinks", or XSym files. These are special text files that behave as symlinks inside the container (on CIFS filesystem), but appear as simple text files on the Windows host. (on the CIFS filesystem used by Docker for Windows inside the container there is no capability to create real symlinks, even though Windows now has this capability.)
- DDEV-Local attempts to clean up for this situation. Since Windows 10 (in developer mode) can now create real symlinks, DDEV-Local scans your repository after a
ddev composercommand and attempts to convert XSym files into real symlinks. It can only do this if your Windows 10 host is set to Developer Mode.
- On Windows 10, to set your computer to developer mode, search for "developer" in settings. Screenshots are below.
ddev composer --versionor
ddev composer -Vwill not work, since
ddevtries to utilize the command for itself. Use
ddev exec composer --versioninstead.
- Quotes, "@" signs and asterisks can cause troubles, since they get eaten up by the bash on the host. In such cases use double quotes, e.g.:
ddev composer require "'drupal/core:9.0.0 as 8.9.0'" --no-update
ddev composer config repositories.local path "'packages/*'"
ddev composer require "my-company/my-sitepackage:@dev" --no-update
If you encounter any other scenario, consider using
ddev ssh and run composer inside the container as outlined above.
Email Capture and Review¶
MailHog is a mail catcher which is configured to capture and display emails sent by PHP in the development environment.
After your project is started, access the MailHog web interface at its default port like this:
http://mysite.ddev.site:8025 or just use
ddev launch -m to get to it.
Please note this will not intercept emails if your application is configured to use SMTP or a 3rd-party ESP integration. If you are using SMTP for outgoing mail handling (Swift Mailer or SMTP modules for example), update your application configuration to use
localhost on port
1025 as the SMTP server locally in order to use MailHog.
phpMyAdmin is a free software tool to manage MySQL and MariaDB databases from a browser. phpMyAdmin comes installed with ddev. After your project is started, use
ddev launch -p or just access the phpMyAdmin web interface at its default port,
If you use the free Sequel Pro database browser for macOS, run
ddev sequelpro within a project folder, and Sequel Pro will launch and access the database for that project.
Using Development Tools on the Host Machine¶
It is possible in many cases to use development tools installed on your host machine on a project provisioned by ddev. Tools that interact with files and require no database connection, such as Git or Composer, can be run from the host machine against the code base for a ddev project with no additional configuration necessary.
Database Connections from the Host¶
If you need to connect to the database of your project from the host machine, run
ddev describe to retrieve the database connection information. The last line of the database credentials will provide your host connection info, similar to this:
To connect to mysql from your host machine, use port 32838 on 127.0.0.1 For example: mysql --host 127.0.0.1 --port 32838
The port referenced is unique per running project, and randomly chosen from available ports on your system when you run
Note: The host database port is likely to change any time a project is stopped/removed and then later started again.
Using Drush 8 installed Installation on the Host Computer¶
Warning: Using drush on the host is discouraged, and you'll have some trouble with it. It's also mostly irrelevant for Drupal8, as you should be using composer-installed project-level drush.
If you have PHP and Drush installed on your host system and the environment variable IS_DDEV_PROJECT=true, you can use drush to interact with a ddev project. On the host system the extra include host-side configuration for the database and port are derived in the settings.ddev.php file to allow drush to access the database server. This may not work for all drush commands because of course the actual webserver environment is not available.
Note that on Drupal 8+ if you want to use
drush uli on the host (or other drush commands that require a default URI), you'll need to set DRUSH_OPTIONS_URI on the host. For example,
DDEV and Terminus¶
Terminus is a command line tool providing advanced interaction with Pantheon services. As of version 1.13.0, terminus is available inside the project's container, allowing users to get information from, or issue commands to their Pantheon-hosted sites. This is an especially helpful feature for Windows users as terminus is only officially supported on unix-based systems.
To use terminus, you'll first need to:
- Authenticate ddev with a pantheon machine token (more info here)
ddev sshto tunnel into your container
- Issue a command using the keyword
terminus. For help using terminus try
terminus listto get a list of possible commands.
Terminus also allows you to issue drush, WP-CLI, composer, and drupal console commands to your pantheon server. These are all usable from within the container as well, but will require authentication via either your Pantheon password or an SSH key. To use your host machine's SSH key, you can use the
ddev auth ssh command described here.