terminus-plugin-project/terminus-site-status-plugin

Site Status - A Terminus plugin that displays the status of all available Pantheon site environments.

2.0.1 2023-03-02 19:19 UTC

This package is auto-updated.

Last update: 2024-10-30 01:59:18 UTC


README

Version 2.x

CircleCI Terminus v2.x Compatible Terminus v1.x Compatible Terminus v0.x Compatible

Terminus plugin that displays the status of all available Pantheon site environments.

Usage:

$ terminus site:status [--team] [--owner] [--org=<id>] [--name=<regex>]

The associative arguments are all optional and the same filtering rules as the terminus site:list command apply.

The output will be displayed in a table format. The Condition column displays whether there are pending filesystem changes.

If the Condition column displays dirty, it means the code is out of sync with the repository.

Examples:

Display the status of all available site environments.

terminus site:status

Display the status of all site enviroments that contain 'awesome' in the name.

terminus site:status --name=awesome

Learn more about Terminus and Terminus Plugins.

Installation:

For installation help, see Manage Plugins.

mkdir -p ~/.terminus/plugins
composer create-project -d ~/.terminus/plugins terminus-plugin-project/terminus-site-status-plugin:~2

Configuration:

This plugin requires no configuration to use.

Testing:

cd ~/.terminus/plugins/terminus-site-status-plugin
composer install
composer test

Help:

Run terminus help site:status for help.