github-status 1.1.0

github-status is a CLI to check the status of GitHub.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# GitHub Status

![Tests Status](https://github.com/sanders41/github-status/workflows/Testing/badge.svg?branch=main&event=push)

A simple Cli to check the status of GitHub

## Install

Clone and install the repositry

```sh
git clone git@github.com/sanders41/github-status
cd github-status
cargo install github-status
```

This will install to the `~/.cargo/bin` directory

## Usage

```sh
Checks the status of GitHub

Usage: github-status <COMMAND>

Commands:
  active-maintenance          Gets a list of active maintenance
  all-incidents               Gets a list of all incidents
  all-scheduled-maintenances  Gets a list of the 50 most recent scheduled maintenances
  component                   Status of each component
  status                      Gets the current status
  summary                     Gets a summary for the current GitHub status
  unresolved-incidents        Gets a list of any unresolved incidents
  upcoming-maintenance        Gets a list of upcoming maintenance
  help                        Print this message or the help of the given subcommand(s)
```

## Example

```sh
github-status summary
```

![Summary](./assets/summary.png)

## Contributing

Contributions to this project are welcome. If you are interesting in contributing please see our [contributing guide](CONTRIBUTING.md)