PHPackages                             pantheon-systems/terminus-plugin-example - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. pantheon-systems/terminus-plugin-example

ActiveTerminus-plugin[CLI &amp; Console](/categories/cli)

pantheon-systems/terminus-plugin-example
========================================

An example Terminus command

2.0.4(1y ago)54.6k7[1 issues](https://github.com/pantheon-systems/terminus-plugin-example/issues)[3 PRs](https://github.com/pantheon-systems/terminus-plugin-example/pulls)MITPHPCI passing

Since Feb 22Pushed 3w ago45 watchersCompare

[ Source](https://github.com/pantheon-systems/terminus-plugin-example)[ Packagist](https://packagist.org/packages/pantheon-systems/terminus-plugin-example)[ RSS](/packages/pantheon-systems-terminus-plugin-example/feed)WikiDiscussions 2.x Synced 2d ago

READMEChangelog (4)Dependencies (3)Versions (22)Used By (0)

Terminus Plugin Example
=======================

[](#terminus-plugin-example)

[![CI](https://github.com/pantheon-systems/terminus-plugin-example/actions/workflows/main.yaml/badge.svg)](https://github.com/pantheon-systems/terminus-plugin-example/actions/workflows/main.yaml)[![Actively Maintained](https://camo.githubusercontent.com/2ae5ff81f271fb028d720adee6b3595770166f3707a4705a4a2a3b71c332b249/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f50616e7468656f6e2d4163746976656c795f4d61696e7461696e65642d79656c6c6f773f6c6f676f3d70616e7468656f6e26636f6c6f723d464644433238)](https://pantheon.io/docs/oss-support-levels#actively-maintained-support)

[![Terminus v2.x - v3.x Compatible](https://camo.githubusercontent.com/821e676ff8016707d094378b4c5b2039303974e8c2ab9043d97744adaa0f6eed/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7465726d696e75732d322e782532302d2d253230332e782d677265656e2e737667)](https://github.com/pantheon-systems/terminus-plugin-example/tree/2.x)

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](https://pantheon.io/docs/terminus/plugins)

Configuration
-------------

[](#configuration)

These commands require no configuration

Usage
-----

[](#usage)

- `terminus hello`
- `terminus auth:hello`

Installation
------------

[](#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
-------

[](#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`

### CI

[](#ci)

All jobs run on every push and PR with no setup needed. Tests that require a `TERMINUS_TOKEN` (a Terminus machine token) are skipped automatically when the secret isn't set.

Help
----

[](#help)

Run `terminus help auth:hello` for help.

###  Health Score

50

—

FairBetter than 95% of packages

Maintenance69

Regular maintenance activity

Popularity27

Limited adoption so far

Community24

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~380 days

Recently: every ~431 days

Total

8

Last Release

21d ago

Major Versions

1.x-dev → 2.0.02021-09-01

### Community

Maintainers

![](https://www.gravatar.com/avatar/b34cc6bd882277b6c6dda19bf6631ae5c3a909fd667c826a15121642cdc051b2?d=identicon)[greg.1.anderson](/maintainers/greg.1.anderson)

![](https://www.gravatar.com/avatar/5a89f5f15357797cbd6ec7833a28626478ae3c0ceb5fa1faa8a26d0960584c65?d=identicon)[pantheon-systems](/maintainers/pantheon-systems)

---

Top Contributors

[![kporras07](https://avatars.githubusercontent.com/u/2217820?v=4)](https://github.com/kporras07 "kporras07 (19 commits)")[![greg-1-anderson](https://avatars.githubusercontent.com/u/612191?v=4)](https://github.com/greg-1-anderson "greg-1-anderson (13 commits)")[![namespacebrian](https://avatars.githubusercontent.com/u/87093053?v=4)](https://github.com/namespacebrian "namespacebrian (4 commits)")[![lowlostrong](https://avatars.githubusercontent.com/u/239265111?v=4)](https://github.com/lowlostrong "lowlostrong (2 commits)")[![TohaUA](https://avatars.githubusercontent.com/u/4780023?v=4)](https://github.com/TohaUA "TohaUA (2 commits)")[![EdwardAngert](https://avatars.githubusercontent.com/u/17991901?v=4)](https://github.com/EdwardAngert "EdwardAngert (1 commits)")[![bhavanvir](https://avatars.githubusercontent.com/u/20825496?v=4)](https://github.com/bhavanvir "bhavanvir (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/pantheon-systems-terminus-plugin-example/health.svg)

```
[![Health](https://phpackages.com/badges/pantheon-systems-terminus-plugin-example/health.svg)](https://phpackages.com/packages/pantheon-systems-terminus-plugin-example)
```

###  Alternatives

[illuminate/console

The Illuminate Console package.

13046.0M6.5k](/packages/illuminate-console)[styleci/cli

The CLI tool for StyleCI

71470.5k9](/packages/styleci-cli)[winbox/args

Windows command-line formatter

20720.9k21](/packages/winbox-args)[tomatophp/filament-artisan

Simple but yet powerful library for running some artisan commands for FilamentPHP

3275.4k1](/packages/tomatophp-filament-artisan)[thettler/laravel-console-toolkit

This Package provides some usefully console features like the attribute syntax for arguments and options, validation, auto ask and casting.

324.1k](/packages/thettler-laravel-console-toolkit)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
