pantheon-systems/terminus-plugin-example

An example Terminus command

2.0.1 2021-09-20 20:37 UTC

README

CircleCI Actively Maintained

Terminus v2.x - v3.x Compatible

A simple plugin for Terminus-CLI to demonstrate how to add new commands.

Adds commands 'hello' and 'auth:hello' to Terminus. Learn more about Terminus Plugins in the Terminus Plugins documentation

Configuration

These commands require no configuration

Usage

  • terminus hello
  • terminus auth:hello

Installation

To install this plugin using Terminus 3:

terminus self:plugin:install terminus-plugin-example

On older versions of Terminus:

mkdir -p ~/.terminus/plugins
curl https://github.com/pantheon-systems/terminus-plugin-example/archive/2.x.tar.gz -L | tar -C ~/.terminus/plugins -xvz

Testing

This example project includes four testing targets:

  • composer lint: Syntax-check all php source files.
  • composer cs: Code-style check.
  • composer unit: Run unit tests with phpunit
  • composer functional: Run functional test with bats

To run all tests together, use composer test.

Note that prior to running the tests, you should first run:

  • composer install
  • composer install-tools

Help

Run terminus help auth:hello for help.