Skip to main content
Command

terminus site:upstream:set


Description

Changes a site upstream.

Example Usage

terminus site:upstream:set <site_name> <upstream_id>

site:upstream:set <site> <upstream_id> Updates <site>'s upstream to <upstream_id>.


Options

OptionDescription
--ansiForce (or disable --no-ansi) ANSI output
--defineDefine a configuration item value.
--helpDisplay help for the given command. When no command is given display help for the <info>list</info> command
--no-ansiNegate the "--ansi" option
--no-interactionDo not ask any interactive question
--quietDo not output any message
--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"

Example

terminus site:upstream:set my-site "My Custom Upstream"

You can use any valid identifier (upstream name, upstream machine name, upstream UUID) returned in upstream:list to set a new upstream. For example, the upstream name "My Custom Upstream" is used above.

As a safeguard, Terminus will prevent a framework switch such as moving from Drupal to WordPress or vice versa.

To set an empty upstream for Composer-managed sites, see Serving Sites from the Web Subdirectory.

After setting the upstream, you must bring in the new codebase by applying updates to the site.

Terminus Error: Permission to change the upstream of this site

If you encounter an error when setting a site's upstream:

terminus site:upstream:set $SITE $UPSTREAM
 [error]  You do not have permission to change the upstream of this site.

Confirm that the user you are authenticated as has the correct Site-level permissions.

To check the currently authenticated user:

terminus auth:whoami
Back to all commands