Skip to content

Commit d7e6333

Browse files
authored
feat: add examples for group cmd (#261)
1 parent d6483cb commit d7e6333

1 file changed

Lines changed: 26 additions & 2 deletions

File tree

alertaclient/commands/cmd_group.py

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,34 @@
1010
@click.option('--text', help='Description of user group')
1111
@click.option('--user', '-U', help='Add user to group')
1212
@click.option('--users', is_flag=True, metavar='ID', help='Get list of group users')
13-
@click.option('--delete', '-D', metavar='ID', help='Delete user group using ID')
13+
@click.option('--delete', '-D', metavar='ID', help='Delete user group, or remove user from group')
1414
@click.pass_obj
1515
def cli(obj, id, name, text, user, users, delete):
16-
"""Create or delete a user group."""
16+
"""
17+
Create or delete a user group, add and remove users from groups.
18+
19+
EXAMPLES
20+
21+
Create a group.
22+
23+
$ alerta group --name <group-name> --text <description>
24+
25+
Add a user to a group.
26+
27+
$ alerta group -id <group-id> --user <user-id>
28+
29+
List users in a group.
30+
31+
$ alerta group <group-id> --users
32+
33+
Delete a user from a group.
34+
35+
$ alerta group -id <group-id> -D <user-id>
36+
37+
Delete a group.
38+
39+
$ alerta group -D <group-id>
40+
"""
1741
client = obj['client']
1842
if id and user:
1943
client.add_user_to_group(id, user)

0 commit comments

Comments
 (0)