UNPKG

2.85 kBMarkdownView Raw
1CLI Plugin for [Heroku Status](https://status.heroku.com)
2===========
3
4[![Version](https://img.shields.io/npm/v/@heroku-cli/plugin-status.svg)](https://npmjs.org/package/@heroku-cli/plugin-status)
5[![CircleCI](https://circleci.com/gh/heroku/heroku-cli-status/tree/master.svg?style=svg)](https://circleci.com/gh/heroku/heroku-cli-status/tree/master)
6[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/heroku/heroku-cli-status?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/heroku-cli-status/branch/master)
7[![Codecov](https://codecov.io/gh/heroku/heroku-cli-status/branch/master/graph/badge.svg)](https://codecov.io/gh/heroku/heroku-cli-status)
8[![Greenkeeper](https://badges.greenkeeper.io/heroku/heroku-cli-status.svg)](https://greenkeeper.io/)
9[![Known Vulnerabilities](https://snyk.io/test/npm/@heroku-cli/plugin-status/badge.svg)](https://snyk.io/test/npm/@heroku-cli/plugin-status)
10[![Downloads/week](https://img.shields.io/npm/dw/@heroku-cli/plugin-status.svg)](https://npmjs.org/package/@heroku-cli/plugin-status)
11[![License](https://img.shields.io/npm/l/@heroku-cli/plugin-status.svg)](https://github.com/heroku/heroku-cli-status/blob/master/package.json)
12
13How to install this plugin
14-------------------
15
16This CLI comes built into the Heroku CLI. https://cli.heroku.com
17
18Available commands
19-------------------
20
21```bash
22$ heroku status
23=== Heroku Status
24Development: No known issues at this time.
25Production: No known issues at this time.
26```
27
28or, if there were a real incident...
29
30```bash
31$ heroku status
32=== Heroku Status
33Development: Yellow
34Production: Yellow
35
36=== Increased Platform Latency 7:04:22 PM UTC
377:04:22 PM UTC (42 minutes ago) [Issue] We are experiencing a network connectivity issue with our upstream provider. We will post another update as to the status in an hour if not sooner.
38```
39
40More about https://devcenter.heroku.com/articles/heroku-status
41
42
43
44<!-- install -->
45# Install
46
47with yarn:
48```
49$ yarn global add @heroku-cli/plugin-status
50```
51
52or with npm:
53```
54$ npm install -g @heroku-cli/plugin-status
55```
56<!-- installstop -->
57<!-- usage -->
58```sh-session
59$ npm install -g @heroku-cli/plugin-status
60$ @heroku-cli/plugin-status COMMAND
61running command...
62$ @heroku-cli/plugin-status (-v|--version|version)
63@heroku-cli/plugin-status/7.9.1 darwin-x64 node-v10.9.0
64$ @heroku-cli/plugin-status --help [COMMAND]
65USAGE
66 $ @heroku-cli/plugin-status COMMAND
67...
68```
69<!-- usagestop -->
70<!-- commands -->
71* [`@heroku-cli/plugin-status status`](#heroku-cli-plugin-status-status)
72
73## `@heroku-cli/plugin-status status`
74
75display current status of the Heroku platform
76
77```
78USAGE
79 $ @heroku-cli/plugin-status status
80
81OPTIONS
82 --json output in json format
83```
84
85_See code: [src/commands/status.ts](https://github.com/heroku/cli/blob/v7.9.1/packages/status/src/commands/status.ts)_
86<!-- commandsstop -->