Fix help text

Author: satterly

alertaclient/commands/cmd_customer.py

@@ -5,8 +5,8 @@
 
 @click.command('customer', short_help='Add customer lookup')
 @click.option('--customer', help='customer name')
-@click.option('--org', '--group', '--domain', '--role', 'match', help='used to lookup customer')
-@click.option('--delete', '-D', metavar='ID', help='delete customer')
+@click.option('--org', '--group', '--domain', '--role', 'match', help='Used to lookup customer')
+@click.option('--delete', '-D', metavar='ID', help='Delete customer lookup')
 @click.pass_obj
 def cli(obj, customer, match, delete):
     """Add group/org/domain/role-to-customer or delete lookup entry."""

alertaclient/commands/cmd_heartbeat.py

@@ -10,8 +10,8 @@
 @click.command('heartbeat', short_help='Send a heartbeat')
 @click.option('--origin', default='{}/{}'.format(prog, platform.uname()[1]))
 @click.option('--tag', '-T', 'tags', multiple=True)
-@click.option('--timeout', metavar='EXPIRES', help='seconds before heartbeat is stale')
-@click.option('--delete', '-D', metavar='ID', help='delete hearbeat')
+@click.option('--timeout', metavar='EXPIRES', help='Seconds before heartbeat is stale')
+@click.option('--delete', '-D', metavar='ID', help='Delete hearbeat')
 @click.pass_obj
 def cli(obj, origin, tags, timeout, delete):
     """Send or delete a heartbeat."""

alertaclient/commands/cmd_heartbeats.py

@@ -5,7 +5,7 @@
 
 
 @click.command('heartbeats', short_help='List heartbeats')
-@click.option('--purge', is_flag=True)
+@click.option('--purge', is_flag=True, help='Delete stale heartbeats')
 @click.pass_obj
 @click.pass_context
 def cli(ctx, obj, purge):

alertaclient/commands/cmd_key.py

@@ -6,10 +6,10 @@
 
 @click.command('key', short_help='Create API key')
 @click.option('--username', '-u')
-@click.option('--scope', 'scopes', multiple=True)
+@click.option('--scope', 'scopes', multiple=True, help='List of permissions eg. admin:keys, write:alerts')
 @click.option('--duration', type=int)
 @click.option('--text')
-@click.option('--delete', '-D', metavar='ID', help='delete API key')
+@click.option('--delete', '-D', metavar='ID', help='Delete API key')
 @click.pass_obj
 def cli(obj, username, scopes, duration, text, delete):
     """Create or delete an API key."""

alertaclient/commands/cmd_perm.py

@@ -5,8 +5,8 @@
 
 @click.command('perm', short_help='Add role-permission lookup')
 @click.option('--role', help='role name')
-@click.option('--scope', 'scopes', multiple=True, help='list of permissions for role')
-@click.option('--delete', '-D', metavar='ID', help='delete role')
+@click.option('--scope', 'scopes', multiple=True, help='List of permissions eg. admin:keys, write:alerts')
+@click.option('--delete', '-D', metavar='ID', help='Delete role')
 @click.pass_obj
 def cli(obj, role, scopes, delete):
     """Add or delete role-to-permission lookup entry."""

alertaclient/commands/cmd_revoke.py

@@ -6,7 +6,7 @@
 
 
 @click.command('revoke', short_help='Revoke API key')
-@click.option('--api-key', '-K', required=True)
+@click.option('--api-key', '-K', required=True, help='API Key or UUID')
 @click.pass_context
 def cli(ctx, api_key):
     ctx.invoke(revoke, delete=api_key)

alertaclient/commands/cmd_send.py

@@ -5,21 +5,21 @@
 
 
 @click.command('send', short_help='Send an alert')
-@click.option('--resource', '-r', metavar='RESOURCE', required=True, help='resource under alarm')
-@click.option('--event', '-e', metavar='EVENT', required=True, help='event name')
-@click.option('--environment', '-E', metavar='ENVIRONMENT', help='environment eg. Production, Development')
-@click.option('--severity', '-s', metavar='SEVERITY', help='severity eg. critical, major, minor, warning')
-@click.option('--correlate', '-C', metavar='EVENT', multiple=True, help='list of related events eg. node_up, node_down')
-@click.option('--service', '-S', metavar='SERVICE', multiple=True, help='list of affected services eg. app name, Web, Network, Storage, Database, Security')
-@click.option('--group', '-g', metavar='GROUP', help='group event by type eg. OS, Performance')
-@click.option('--value', '-v', metavar='VALUE', help='string event value')
-@click.option('--text', '-t', metavar='DESCRIPTION', help='description of alert')
-@click.option('--tag', '-T', 'tags', multiple=True, metavar='TAG', help='list of tags eg. London, os:linux, AWS/EC2')
-@click.option('--attributes', '-A', multiple=True, metavar='KEY=VALUE', help='list of attributes eg. priority=high')
-@click.option('--origin', '-O', metavar='ORIGIN', help='origin of alert in form app/host')
-@click.option('--type', metavar='EVENT_TYPE', help='event type eg. exceptionAlert, performanceAlert, nagiosAlert')
-@click.option('--timeout', metavar='EXPIRES', help='seconds before an open alert will be expired')
-@click.option('--raw-data', metavar='STRING', help='raw data of orignal alert eg. SNMP trap PDU')
+@click.option('--resource', '-r', metavar='RESOURCE', required=True, help='Resource under alarm')
+@click.option('--event', '-e', metavar='EVENT', required=True, help='Event name')
+@click.option('--environment', '-E', metavar='ENVIRONMENT', help='Environment eg. Production, Development')
+@click.option('--severity', '-s', metavar='SEVERITY', help='Severity eg. critical, major, minor, warning')
+@click.option('--correlate', '-C', metavar='EVENT', multiple=True, help='List of related events eg. node_up, node_down')
+@click.option('--service', '-S', metavar='SERVICE', multiple=True, help='List of affected services eg. app name, Web, Network, Storage, Database, Security')
+@click.option('--group', '-g', metavar='GROUP', help='Group event by type eg. OS, Performance')
+@click.option('--value', '-v', metavar='VALUE', help='Event value')
+@click.option('--text', '-t', metavar='DESCRIPTION', help='Description of alert')
+@click.option('--tag', '-T', 'tags', multiple=True, metavar='TAG', help='List of tags eg. London, os:linux, AWS/EC2')
+@click.option('--attributes', '-A', multiple=True, metavar='KEY=VALUE', help='List of attributes eg. priority=high')
+@click.option('--origin', '-O', metavar='ORIGIN', help='Origin of alert in form app/host')
+@click.option('--type', metavar='EVENT_TYPE', help='Event type eg. exceptionAlert, performanceAlert, nagiosAlert')
+@click.option('--timeout', metavar='EXPIRES', help='Seconds before an open alert will be expired')
+@click.option('--raw-data', metavar='STRING', help='Raw data of orignal alert eg. SNMP trap PDU')
 @click.pass_obj
 def cli(obj, resource, event, environment, severity, correlate, service, group, value, text, tags, attributes, origin, type, timeout, raw_data):
     """Send an alert."""

alertaclient/commands/cmd_tag.py

@@ -6,7 +6,7 @@
 @click.command('tag', short_help='Tag alerts')
 @click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
-@click.option('--tag', '-T', 'tags', required=True, multiple=True)
+@click.option('--tag', '-T', 'tags', required=True, multiple=True, help='List of tags')
 @click.pass_obj
 def cli(obj, ids, filters, tags):
     """Add tags to alerts."""

alertaclient/commands/cmd_untag.py

@@ -6,7 +6,7 @@
 @click.command('untag', short_help='Untag alerts')
 @click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
-@click.option('--tag', '-T', 'tags', required=True, multiple=True)
+@click.option('--tag', '-T', 'tags', required=True, multiple=True, help='List of tags')
 @click.pass_obj
 def cli(obj, ids, filters, tags):
     """Remove tags from alerts."""

alertaclient/commands/cmd_update.py

@@ -6,7 +6,7 @@
 @click.command('update', short_help='Update alert attributes')
 @click.option('--ids', '-i', metavar='UUID', multiple=True, help='List of alert IDs (can use short 8-char id)')
 @click.option('--filter', '-f', 'filters', metavar='FILTER', multiple=True, help='KEY=VALUE eg. serverity=warning resource=web')
-@click.option('--attributes', '-A', multiple=True, metavar='KEY=VALUE', help='list of attributes eg. priority=high')
+@click.option('--attributes', '-A', multiple=True, metavar='KEY=VALUE', help='List of attributes eg. priority=high')
 @click.pass_obj
 def cli(obj, ids, filters, attributes):
     """Update alert attributes."""