-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update Readme
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |