Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
Update Readme
  • Loading branch information
rag594 authored Jun 22, 2023
1 parent 18feca3 commit 236c285
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# nimbus
CLI based tool to query VMAlerts.VMAlerts Ui is currently cluttered and too slow.Want fast access to your rules/alerts then just nimbus it.

## Install


## Usage

### Alerts

```console
foo@bar:~$ nimbus alerts help
NAME:
CLI for VM Alerts alerts - get the list of alerts and other info(state, description etc)

USAGE:
use team or alertGroup flags to get info on team/alertGroup wise alerts

OPTIONS:
--team value team wise alerts in firing or pending state
--alertGroup value group wise alerts in firing or pending state
--help, -h show help
```

### Groups

```console
foo@bar:~$ nimbus group help
NAME:
CLI for VM Alerts group - lists down the rules

USAGE:
use name flag to get info alertRules applied and get their state

OPTIONS:
--name value list rules name wise
--help, -h show help
```

0 comments on commit 236c285

Please sign in to comment.