Command Directory
Review a complete list of Terminus commands.
Discuss in our Forum Discuss in SlackThis section provides a comprehensive list of Terminus commands.
Note
If you would like additional information for a specific Terminus command (for example, available --format options) run the command with the --help flag in your terminal.
Command Structure
Basic Format
The basic format of a Terminus command is:
terminus command:subcommand <site>.<env>Read below for a complete list of Terminus commands, or use the search box to look up a specific command.
| Command | Usage |
|---|---|
| aliases 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.pantheon.io/guides/drush/drush-aliases#manage-available-site-aliases-lists for more information. | aliases --print --location LOCATION --all --only ONLY --type TYPE --base BASE --db-url DB-URL --target TARGET --no-db-url |
| art Displays Pantheon ASCII artwork. | art <name> |
| completion Dump the shell completion script | completion --debug -- <shell> |
| help Display help for a command | help --format FORMAT --raw -- <command_name> |
| list List commands | list --raw --format FORMAT --short -- <namespace> |
| auth:login Logs in a user to Pantheon. | auth:login --machine-token MACHINE-TOKEN --email EMAIL |
| auth:logout Logs out the currently logged-in user and deletes any saved machine tokens. | auth:logout |
| auth:whoami Displays information about the currently logged-in user. | auth:whoami --format FORMAT --fields FIELDS --field FIELD |
| backup:automatic:disable Disables automatic backups. | backup:automatic:disable <site>.<env> |
| backup:automatic:enable Enables automatic daily backups that are retained for one week and weekly backups retained for one month. | backup:automatic:enable --day DAY --keep-for KEEP-FOR -- <site>.<env> |
| backup:automatic:info Displays the hour when daily backups are created and the day of the week when weekly backups are created. | backup:automatic:info --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| backup:create Creates a backup of a specific site and environment. | backup:create --element ELEMENT --keep-for KEEP-FOR -- <site>.<env> |
| backup:get Displays the download URL for a specific backup or latest backup. | backup:get --file FILE --element ELEMENT --to TO -- <site>.<env> |
| backup:info Displays information about a specific backup or the latest backup. | backup:info --file FILE --element ELEMENT --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| backup:list Lists backups for a specific site and environment. | backup:list --element ELEMENT --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| backup:restore Restores a specific backup or the latest backup. | backup:restore --file FILE --element ELEMENT -- <site>.<env> |
| branch:list Displays list of git branches for a site. | branch:list --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| connection:info Displays connection information for Git, SFTP, MySQL, and Redis. | connection:info --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| connection:set Sets Git or SFTP connection mode on a development environment (excludes Test and Live). | connection:set <site>.<env> <mode> |
| dashboard:view Displays the URL for the Pantheon Dashboard or opens the Dashboard in a browser. | dashboard:view --print -- <site>.<env> |
| domain:add Associates a domain with the environment. | domain:add <site>.<env> <domain> |
| domain:dns Displays recommended DNS settings for the environment. | domain:dns --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| domain:list Displays domains associated with the environment. | domain:list --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| domain:lookup Displays site and environment with which a given domain is associated. Note: Only sites for which the user is authorized will appear. | domain:lookup --format FORMAT --fields FIELDS --field FIELD -- <domain> |
| domain:primary:add Sets a domain associated to the environment as primary, causing all traffic to redirect to it. | domain:primary:add <site>.<env> <domain> |
| domain:primary:remove Removes the primary designation from the primary domain in the site and environment. | domain:primary:remove <site>.<env> |
| domain:remove Disassociates a domain from the environment. | domain:remove <site>.<env> <domain> |
| env:clear-cache Clears caches for the environment. | env:clear-cache <site>.<env> |
| env:clone-content Clones database/files from one environment to another environment. WordPress sites will search the database for the default domain and replace it with the target environment's domain unless you specify a different search/replace string with --search-for and --replace-with. | env:clone-content --cc --db-only --files-only --updatedb --from-url FROM-URL --to-url TO-URL -- <site>.<env> <target_env> |
| env:code-log Displays the code log for the environment. | env:code-log --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| env:code-rebuild Rebuild code for the given environment (only dev and multidev allowed). | env:code-rebuild <site>.<env> |
| env:commit Commits code changes on a development environment. Note: The environment connection mode must be set to SFTP. | env:commit --message MESSAGE --force -- <site>.<env> |
| env:deploy Deploys code to the Test or Live environment. Notes: - Deploying the Test environment will deploy code from the Dev environment. - Deploying the Live environment will deploy code from the Test environment. | env:deploy --sync-content --note NOTE --cc --updatedb -- <site>.<env> |
| env:diffstat Displays the diff of uncommitted code changes on a development environment. | env:diffstat --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| env:info Displays environment status and configuration. | env:info --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| env:list Displays a list of the site environments. | env:list --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| env:metrics Displays the pages served and unique visit metrics for the specified site environment. The most recent data up to the current day is returned. | env:metrics --period PERIOD --datapoints DATAPOINTS --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| env:rotate-random-seed Rotate random seed for the environment. | env:rotate-random-seed <site>.<env> |
| env:view Displays the URL for the environment or opens the environment in a browser. | env:view --print -- <site>.<env> |
| env:wake Wakes the environment by pinging it. Note: Development environments and Sandbox sites will automatically sleep after a period of inactivity. | env:wake <site>.<env> |
| env:wipe Deletes all files and database content in the environment. | env:wipe <site>.<env> |
| https:info Provides information for HTTPS on being used for the environment. | https:info --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| https:remove Disables HTTPS and removes the SSL certificate from the environment. | https:remove <site>.<env> |
| https:set Enables HTTPS and/or updates the SSL certificate for the environment. | https:set --intermediate-certificate INTERMEDIATE-CERTIFICATE -- <site>.<env> <certificate> <private_key> |
| import:complete Finalizes the Pantheon import process. | import:complete <site_name> |
| import:database Imports a database archive to the environment. This command drops the existing database and imports the target into a new database. Use with caution to avoid accidental database deletion. | import:database <site>.<env> <url> |
| import:files Imports a file archive to the environment. | import:files <site>.<env> <url> |
| import:site Imports a site archive (code, database, and files) to the site. | import:site <site_name> <url> |
| local:clone CLone a copy of the site code into $HOME/pantheon-local-copies | local:clone --site_dir SITE_DIR --override OVERRIDE -- <site_id> |
| local:commitAndPush Commit local changes to remote repository. | local:commitAndPush <site> |
| local:getLiveDB Create new backup of your live site db and download to $HOME/pantheon-local-copies/db | local:getLiveDB --overwrite -- <site> |
| local:getLiveFiles Create new backup of your live site FILES folder and download to $HOME/pantheon-local-copies/files | local:getLiveFiles --overwrite -- <site> |
| lock:disable Disables HTTP basic authentication on the environment. | lock:disable <site>.<env> |
| lock:enable Enables HTTP basic authentication on the environment. Note: HTTP basic authentication username and password are stored in plaintext. | lock:enable <site>.<env> <username> <password> |
| lock:info Displays HTTP basic authentication status and configuration for the environment. | lock:info --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| machine-token:delete Deletes a currently logged-in user machine token. | machine-token:delete <machine_token_id> |
| machine-token:delete-all Delete all stored machine tokens and log out. | machine-token:delete-all |
| machine-token:list Lists the currently logged-in user machine tokens. | machine-token:list --format FORMAT --fields FIELDS --field FIELD |
| multidev:create Creates a multidev environment. If there is an existing Git branch with the multidev name, then it will be used when the new environment is created. | multidev:create --no-db --no-files -- <site>.<env> <multidev> |
| multidev:delete Deletes a Multidev environment. | multidev:delete --delete-branch -- <site>.<env> |
| multidev:list Lists a site Multidev environments. | multidev:list --format FORMAT --fields FIELDS --field FIELD -- <site_name> |
| multidev:merge-from-dev Merges code commits from the Dev environment into a Multidev environment. | multidev:merge-from-dev --updatedb -- <site>.<env> |
| multidev:merge-to-dev Merges code commits from a Multidev environment into the Dev environment. | multidev:merge-to-dev --updatedb -- <site>.<env> |
| new-relic:disable Disables New Relic for a site. | new-relic:disable <site_id> |
| new-relic:enable Enables New Relic for a site. | new-relic:enable <site_id> |
| new-relic:info Displays New Relic configuration. | new-relic:info --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| org:list Displays the list of organizations. | org:list --format FORMAT --fields FIELDS --field FIELD |
| org:people:add Adds a user to an organization. | org:people:add <organization> <email> <role> |
| org:people:list Displays the list of users associated with an organization. | org:people:list --format FORMAT --fields FIELDS --field FIELD -- <organization> |
| org:people:remove Removes a user from an organization. | org:people:remove <organization> <member> |
| org:people:role Changes a user role within an organization. | org:people:role <organization> <member> <role> |
| org:site:list Displays the list of sites associated with an organization. | org:site:list --plan PLAN --tag TAG --tags TAGS --upstream UPSTREAM --format FORMAT --fields FIELDS --field FIELD -- <organization> |
| org:site:remove Removes a site from an organization. | org:site:remove <organization> <site> |
| org:upstream:list Displays the list of upstreams belonging to an organization. | org:upstream:list --all --framework FRAMEWORK --name NAME --format FORMAT --fields FIELDS --field FIELD -- <organization> |
| owner:set Change the owner of a site | owner:set <site_name> <owner> |
| payment-method:add Associates an existing payment method with a site. | payment-method:add <site_name> <payment_method> |
| payment-method:list Displays the list of payment methods for the currently logged-in user. | payment-method:list --format FORMAT --fields FIELDS --field FIELD |
| payment-method:remove Disassociates the active payment method from a site. | payment-method:remove <site_name> |
| plan:info Displays information about a site plan. | plan:info --format FORMAT --fields FIELDS --field FIELD -- <site> |
| plan:list Displays the list of available site plans. | plan:list --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| plan:set Changes a site plan. | plan:set <site_id> <plan_sku> |
| redis:disable Disables Redis add-on for a site. | redis:disable <site_id> |
| redis:enable Enables Redis add-on for a site. | redis:enable <site_id> |
| remote:drush Runs a Drush command remotely on a site environment. | remote:drush --progress -- <site>.<env> <command>... |
| remote:wp Runs a WP-CLI command remotely on a site environment. | remote:wp --progress -- <site>.<env> <command>... |
| self:clear-cache Clears the local Terminus command cache. | self:clear-cache |
| self:config:dump Displays the local Terminus configuration. | self:config:dump --format FORMAT --fields FIELDS --field FIELD |
| self:console Opens an interactive PHP console within Terminus. Note: This functionality is useful for debugging Terminus or prototyping Terminus plugins. | self:console <site>.<env> |
| self:info Displays the local PHP and Terminus environment configuration. | self:info --format FORMAT --fields FIELDS --field FIELD |
| self:plugin:create Create a new terminus plugin. | self:plugin:create --project-name PROJECT-NAME -- <path> |
| self:plugin:install Install one or more Terminus plugins. | self:plugin:install <projects>... |
| self:plugin:list List all installed Terminus plugins. | self:plugin:list --format FORMAT --fields FIELDS --field FIELD |
| self:plugin:migrate Migrate Terminus 2 plugins. | self:plugin:migrate |
| self:plugin:reload Reload Terminus plugins. | self:plugin:reload |
| self:plugin:search Search for available Terminus plugins. | self:plugin:search --format FORMAT --fields FIELDS --field FIELD -- <keyword> |
| self:plugin:uninstall Remove one or more Terminus plugins. | self:plugin:uninstall <projects>... |
| self:plugin:update Update one or more Terminus plugins. | self:plugin:update <projects>... |
| self:update Updates Terminus to the latest version. | self:update --stable --preview --compatible -- <version_constraint> |
| service-level:set Upgrades or downgrades a site service level. | service-level:set <site_id> <level> |
| site:create Creates a new site. | site:create --org ORG --region REGION -- <site_name> <label> <upstream_id> |
| site:delete Deletes a site from Pantheon. | site:delete <site_id> |
| site:info Displays a site information. | site:info --format FORMAT --fields FIELDS --field FIELD -- <site> |
| site:list Displays the list of sites accessible to the currently logged-in user. | site:list --name NAME --org ORG --owner OWNER --plan PLAN --team --upstream UPSTREAM --format FORMAT --fields FIELDS --field FIELD |
| site:lookup Displays the UUID of a site given its name. | site:lookup --format FORMAT --fields FIELDS --field FIELD -- <site_name> |
| site:org:add Associates a supporting organization with a site. | site:org:add <site> <organization> |
| site:org:list Displays the list of supporting organizations associated with a site. | site:org:list --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| site:org:remove Disassociates a supporting organization from a site. | site:org:remove <site> <organization> |
| site:team:add Adds a user to a site team. Note: An invite will be sent if the email is not associated with a Pantheon account. | site:team:add <site_id> <member> <role> |
| site:team:list Displays the list of team members for a site. | site:team:list --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| site:team:remove Removes a user from a site team. | site:team:remove <site_id> <member> |
| site:team:role Updates a user role on a site team. | site:team:role <site_id> <member> <role> |
| site:upstream:clear-cache Clears caches for the site codeserver. | site:upstream:clear-cache <site> |
| site:upstream:set Changes a site upstream. | site:upstream:set <site_name> <upstream_id> |
| solr:disable Disables Solr add-on for a site. | solr:disable <site_id> |
| solr:enable Enables Solr add-on for a site. | solr:enable <site_id> |
| ssh-key:add Associates a SSH public key with the currently logged-in user. | ssh-key:add <file> |
| ssh-key:list Displays the list of SSH public keys associated with the currently logged-in user. | ssh-key:list --format FORMAT --fields FIELDS --field FIELD |
| ssh-key:remove Disassociates a SSH public key from the currently logged-in user. | ssh-key:remove <ssh_key_id> |
| tag:add Adds a tag on a site within an organization. | tag:add <site_name> <organization> <tag> |
| tag:list Displays the list of tags for a site within an organization. | tag:list --format FORMAT --fields FIELDS --field FIELD -- <site_name> <organization> |
| tag:remove Removes a tag from a site within an organization. | tag:remove <site_name> <organization> <tag> |
| upstream:info Displays information about an upstream. | upstream:info --format FORMAT --fields FIELDS --field FIELD -- <upstream> |
| upstream:list Displays the list of upstreams accessible to the currently logged-in user. | upstream:list --all --framework FRAMEWORK --name NAME --org ORG --format FORMAT --fields FIELDS --field FIELD |
| upstream:updates:apply Applies upstream updates to a site development environment. | upstream:updates:apply --updatedb --accept-upstream -- <site>.<env> |
| upstream:updates:list Displays a cached list of new code commits available from the upstream for a site development environment. Note: To refresh the cache you will need to run site:upstream:clear-cache before running this command. | upstream:updates:list --format FORMAT --fields FIELDS --field FIELD -- <site>.<env> |
| upstream:updates:status Displays a whether there are updates available from the upstream for a site environment. | upstream:updates:status <site>.<env> |
| workflow:info:logs Displays the details of Quicksilver operation logs. | workflow:info:logs --id ID -- <site_id> |
| workflow:info:operations Displays Quicksilver operation details of a workflow. | workflow:info:operations --id ID --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| workflow:info:status Displays the status of a workflow. | workflow:info:status --id ID --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| workflow:list Displays the list of the workflows for a site. | workflow:list --format FORMAT --fields FIELDS --field FIELD -- <site_id> |
| workflow:wait Wait for a workflow to complete. Usually this will be used to wait for code commits, since Terminus will already wait for workflows that it starts through the API. | workflow:wait --start START --max MAX -- <site_env_id> <description> |
| workflow:watch Streams new and finished workflows from a site to the console. | workflow:watch --checks CHECKS -- <site_id> |