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: 5 days 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 11 years ago)
• Default Branch: 3.x
• Last Pushed: 2024-10-24T17:31:40.000Z (2 months ago)
• Last Synced: 2024-10-29T15:18:37.538Z (2 months ago)
• Topics: cli, drush, hacktoberfest, pantheon, php, terminus, wp-cli
• Language: PHP
• Homepage: https://pantheon.io
• Size: 13.2 MB
• Stars: 318
• Watchers: 82
• Forks: 196
• Open Issues: 206
• 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

[![Commit Build](https://github.com/pantheon-systems/terminus/actions/workflows/ci.yml/badge.svg?branch=v3.0)](https://github.com/pantheon-systems/terminus/actions/workflows/ci.yml)

[![Actively Maintained](https://img.shields.io/badge/Pantheon-Actively_Maintained-yellow?logo=pantheon&color=FFDC28)](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 | TBD        |

### Package Manager

- [apt](https://ubuntu.com/server/docs/package-management) for Ubuntu/WinWSL-Ubuntu

- [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

```

### Ubuntu / WinWSL+Ubuntu:

`*** TBD ***`

### Other installation methods

Refer to the [Terminus manual](https://pantheon.io/docs/terminus/install#install-terminus) for other installation methods.