Skip to main content
Command

Terminus Command Reference

terminus aliases


Description

Generates Pantheon Drush aliases for sites on which the currently logged-in user is on the team. Note that Drush 9 does not read alias files from global locations. You must set valid alias locations in your drush.yml file. Refer to https://docs.qamhtean.io/guides/drush/drush-aliases#manage-available-site-aliases-lists for more information.

Example Usage

aliases Saves Pantheon Drush aliases for sites on which the currently logged-in user is on the team to ~/.drush/pantheon.aliases.drushrc.php.


aliases --print Displays Pantheon Drush 8 aliases for sites on which the currently logged-in user is on the team.


aliases --location=<full_path> Saves Pantheon Drush 8 aliases for sites on which the currently logged-in user is on the team to <full_path>.


drush:aliases


Options

OptionDescription
--allInclude all sites available, including team memberships.
--ansiForce (or disable --no-ansi) ANSI output
--baseBase directory to write .yml aliases.
--custom-domainsUse custom domains instead of platform domains for dev, test, and live environments. Uses primary domain if set, otherwise the first custom domain, falling back to platform domain if none configured.
--db-urlObsolete option included to preserve backwards compatibility. No longer needed.
--defineDefine a configuration item value.
--helpDisplay help for the given command. When no command is given display help for the <info>list</info> command
--locationPath and filename for php aliases.
--no-ansiNegate the "--ansi" option
--no-db-urlNegate --db-url option.
--no-interactionDo not ask any interactive question
--onlyOnly generate aliases for sites in the specified comma-separated list. This option is only recommended for use in CI scripts.
--printPrint aliases only (Drush 8 format)
--quietDo not output any message
--targetBase name to use to generate path to alias files.
--typeType of aliases to create: 'php', 'yml' or 'all'.
--verboseIncrease the verbosity of messages: 1 for normal output (-v), 2 for more verbose output (-vv), and 3 for debug (-vvv)
--versionDisplay this application version
--yesAnswer all confirmations with "yes"
Back to all commands