https://github.com/pantheon-systems/terminus
The Pantheon CLI — a standalone utility for performing operations on the Pantheon Platform
https://github.com/pantheon-systems/terminus
cli drush hacktoberfest pantheon php terminus wp-cli
Last synced: about 2 months ago
JSON representation
The Pantheon CLI — a standalone utility for performing operations on the Pantheon Platform
- Host: GitHub
- URL: https://github.com/pantheon-systems/terminus
- Owner: pantheon-systems
- License: other
- Created: 2014-02-22T01:37:07.000Z (almost 12 years ago)
- Default Branch: 4.x
- Last Pushed: 2025-05-06T19:59:45.000Z (9 months ago)
- Last Synced: 2025-05-06T20:35:17.741Z (9 months ago)
- Topics: cli, drush, hacktoberfest, pantheon, php, terminus, wp-cli
- Language: PHP
- Homepage: https://pantheon.io
- Size: 13.1 MB
- Stars: 322
- Watchers: 83
- Forks: 195
- Open Issues: 174
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# terminus : Pantheon's Command-Line Interface
## Status
[](https://github.com/pantheon-systems/terminus/actions/workflows/ci.yml)
[](https://pantheon.io/docs/oss-support-levels#actively-maintained-support)
## 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](https://brew.sh) for mac
#### Required Packages
These packages are required to take full advantage of Terminus.
- [Composer 2](https://getcomposer.org) (Needed for the plugin manager component)
- [PHP](https://www.php.net) (v7.4+)
- [Git](https://help.github.com/articles/set-up-git/) (May be needed for the plugin manager component)
- OpenSSH 7.8 or later
#### Recommended Packages
- [Drush](http://docs.drush.org/en/master/install/) (Useful to run incompatible-with-Terminus Drush commands)
- [WP-CLI](http://wp-cli.org/) (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
```bash
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
```