terminus : Pantheon's Command-Line Interface

Status

About

Terminus is Pantheon's Command Line Interface (CLI), providing at least equivalent functionality to the Pantheon's browser-based Dashboard and easier scripting.

If you would like to contribute, pull requests are welcome!

The Manual

Our documentation is kept in the Terminus Manual, located here: https://pantheon.io/docs/terminus

Requirements

| Operating System | Version | |------------------------|------------| | MacOS | 10.14+ | | Ubuntu | Latest LTS | | Windows + WSL + Ubuntu | 20.0+ |

Package Manager

• Homebrew for mac

Required Packages

These packages are required to take full advantage of Terminus.

• Composer 2 (Needed for the plugin manager component)

• PHP (v8.2+)

• Git (May be needed for the plugin manager component)

• OpenSSH 7.8 or later

Recommended Packages

• Drush (Useful to run incompatible-with-Terminus Drush commands)

• WP-CLI (Useful to run incompatible-with-Terminus WP-CLI commands)

Installation

Mac OS:

Terminus is published as a package under pantheon-systems/external. To install it, you should run:

brew install pantheon-systems/external/terminus

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.6.1/terminus.phar --output terminus
chmod +x terminus
./terminus self:update
sudo ln -s ~/terminus/terminus /usr/local/bin/terminus