Install Terminus

Learn how to install Terminus to your local computer.

Discuss in our Forum Discuss in Slack

This section provides information on how to install and authenticate Terminus.

Terminus is available for macOS and Linux. Windows 10 users can install the Windows Subsystem for Linux, and then install Terminus in the Linux shell.

Some Terminus commands use SSH authentication. You may want to generate and add SSH keys to your account before you continue.

Terminus Requirements

Package Manager

Required Packages

  • PHP Version 7.4 or later (must include the php-xml extension). You can check your PHP version by running php -v from a terminal application.
  • PHP-CLI
  • PHP-CURL
  • Composer
  • Git. This may be needed for the plugin manager component.
  • Drush. This is useful if you need to run Drush commands that are incompatible with Terminus.
  • WP-CLI. This is useful if you need to run WP-CLI commands that are incompatible with Terminus.

Install Terminus

There are several ways to install Terminus, depending on your use case:

Standalone Terminus PHAR

The commands below will:

  • Create a terminus folder in your home directory (~/)

  • Get the latest release tag of Terminus

  • Download and save the release as ~/terminus/terminus

  • Make the file executable

  • Add a symlink to your local bin directory for the Terminus executable

    mkdir -p ~/terminus && cd ~/terminus
    curl -L https://github.com/pantheon-systems/terminus/releases/download/3.1.0/terminus.phar --output terminus
    chmod +x terminus
    ./terminus self:update
    sudo ln -s ~/terminus/terminus /usr/local/bin/terminus

Homebrew Installation

The Terminus application is published to Homebrew.

Run the command below to install Terminus:

brew install pantheon-systems/external/terminus

Authenticate

Machine Token

You must log in with a machine token after the installation completes. A machine token is used to securely authenticate your machine. Machine tokens provide the same access as your username and password, and do not expire. Refer to Machine Tokens for more information.

  1. Navigate to the User Dashboard, select Account, and then select Machine Tokens to create your machine token.

  2. Use your machine token to authenticate into Terminus, replacing email@example.com and <machine_token>:

    terminus auth:login --email=<email@example.com> --machine-token=<machine_token>
    • Machine tokens are keyed to the email address associated with your Pantheon user account. Future sessions are authenticated with your email address after a token has been used to authenticate Terminus:
    terminus auth:login --email <email@example.com>

SSH Authentication

Commands that execute remote instructions to tools like Drush or WP-CLI require SSH authentication. Refer to Generate and Add SSH Keys to prevent password requests when executing these commands.

More Resources