https://github.com/terminus-plugin-project/terminus-site-status-plugin

Site Status - A Terminus plugin that displays the status of all available Pantheon site environments.
https://github.com/terminus-plugin-project/terminus-site-status-plugin

composer pantheon plugin status terminus terminus-plugin

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/terminus-plugin-project/terminus-site-status-plugin
• Owner: terminus-plugin-project
• License: mit
• Created: 2016-12-30T14:58:20.000Z (almost 8 years ago)
• Default Branch: 2.x
• Last Pushed: 2023-03-02T19:22:15.000Z (almost 2 years ago)
• Last Synced: 2024-10-09T05:51:08.271Z (2 months ago)
• Topics: composer, pantheon, plugin, status, terminus, terminus-plugin
• Language: PHP
• Homepage: https://packagist.org/packages/terminus-plugin-project/terminus-site-status-plugin
• Size: 13.7 KB
• Stars: 3
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Terminus Site Status Plugin

Version 2.x

[![CircleCI](https://circleci.com/gh/terminus-plugin-project/terminus-site-status-plugin.svg?style=shield)](https://circleci.com/gh/terminus-plugin-project/terminus-site-status-plugin)

[![Terminus v2.x Compatible](https://img.shields.io/badge/terminus-v2.x-green.svg)](https://github.com/terminus-plugin-project/terminus-site-status-plugin/tree/2.x)

[![Terminus v1.x Compatible](https://img.shields.io/badge/terminus-v1.x-green.svg)](https://github.com/terminus-plugin-project/terminus-site-status-plugin/tree/1.x)

[![Terminus v0.x Compatible](https://img.shields.io/badge/terminus-v0.x-green.svg)](https://github.com/terminus-plugin-project/terminus-site-status-plugin/tree/0.x)

Terminus plugin that displays the status of all available [Pantheon](https://www.pantheon.io) site environments.

## Usage:

```

$ terminus site:status [--team] [--owner] [--org=] [--name=]

```

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

## Installation:

For installation help, see [Manage Plugins](https://pantheon.io/docs/terminus/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.