kaqing 2.0.214__py3-none-any.whl → 2.0.227__py3-none-any.whl

adam/checks/compactionstats.py

@@ -5,6 +5,7 @@ from adam.checks.check_context import CheckContext
 from adam.checks.check_result import CheckResult
 from adam.checks.issue import Issue
 from adam.config import Config
+from adam.utils import Color
 from adam.utils_k8s.cassandra_nodes import CassandraNodes
 
 class CompactionStats(Check):
@@ -15,7 +16,7 @@ class CompactionStats(Check):
         issues: list[Issue] = []
 
         try:
-            result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"nodetool -u {ctx.user} -pw {ctx.pw} compactionstats", show_out=ctx.show_output)
+            result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"nodetool -u {ctx.user} -pw {ctx.pw} compactionstats", show_out=ctx.show_output, text_color=Color.gray)
             compactions = parse_nodetool_compactionstats(result.stdout)
             pod_details = {
                 'name': ctx.pod,

adam/checks/cpu.py

@@ -5,6 +5,7 @@ from adam.checks.check_context import CheckContext
 from adam.checks.check_result import CheckResult
 from adam.checks.issue import Issue
 from adam.config import Config
+from adam.utils import Color
 from adam.utils_k8s.cassandra_nodes import CassandraNodes
 from adam.utils_k8s.custom_resources import CustomResources
 from adam.utils_k8s.pods import Pods
@@ -31,7 +32,7 @@ class Cpu(Check):
                 details['limit'] = container.resources.limits["cpu"]
 
             idle = 'Unknown'
-            result = CassandraNodes.exec(ctx.pod, ctx.namespace, "mpstat 5 2 | grep Average | awk '{print $NF}'", show_out=ctx.show_output)
+            result = CassandraNodes.exec(ctx.pod, ctx.namespace, "mpstat 5 2 | grep Average | awk '{print $NF}'", show_out=ctx.show_output, text_color=Color.gray)
             lines = result.stdout.strip(' \r\n').split('\n')
             line = lines[len(lines) - 1].strip(' \r')
             idle = details['idle'] = line

adam/checks/disk.py

@@ -1,12 +1,13 @@
 import re
 from pathlib import Path
+import traceback
 
 from adam.checks.check import Check
 from adam.checks.check_context import CheckContext
 from adam.checks.check_result import CheckResult
 from adam.checks.issue import Issue
 from adam.config import Config
-from adam.utils import log_exc
+from adam.utils import Color, log_exc
 from adam.utils_k8s.cassandra_nodes import CassandraNodes
 
 class Disk(Check):
@@ -19,16 +20,16 @@ class Disk(Check):
 
         try:
             cass_data_path = Config().get('checks.cassandra-data-path', '/c3/cassandra')
-            df_result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"df -h | grep -e '{cass_data_path}' -e 'overlay'", show_out=ctx.show_output)
+            df_result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"df -h | grep -e '{cass_data_path}' -e 'overlay'", show_out=ctx.show_output, text_color=Color.gray)
 
             snapshot_size = Config().get('checks.snapshot-size-cmd', "ls /c3/cassandra/data/data/*/*/snapshots | grep snapshots | sed 's/:$//g' | xargs -I {} du -sk {} | awk '{print $1}' | awk '{s+=$1} END {print s}'")
-            ss_result = CassandraNodes.exec(ctx.pod, ctx.namespace, snapshot_size, show_out=ctx.show_output)
+            ss_result = CassandraNodes.exec(ctx.pod, ctx.namespace, snapshot_size, show_out=ctx.show_output, text_color=Color.gray)
 
             data_sizes = Config().get('checks.data-size-cmd', "du -sh /c3/cassandra/data/data")
-            ds_result = CassandraNodes.exec(ctx.pod, ctx.namespace, data_sizes, show_out=ctx.show_output)
+            ds_result = CassandraNodes.exec(ctx.pod, ctx.namespace, data_sizes, show_out=ctx.show_output, text_color=Color.gray)
 
             table_sizes = Config().get('checks.table-sizes-cmd', "ls -Al /c3/cassandra/data/data/ | awk '{print $9}' | sed 's/\^r//g' | xargs -I {} du -sk /c3/cassandra/data/data/{}")
-            ts_result = CassandraNodes.exec(ctx.pod, ctx.namespace, table_sizes, show_out=ctx.show_output)
+            ts_result = CassandraNodes.exec(ctx.pod, ctx.namespace, table_sizes, show_out=ctx.show_output, text_color=Color.gray)
 
             result = self.build_details(ctx, df_result.stdout, ss_result.stdout, ds_result.stdout, ts_result.stdout)
 

adam/checks/gossip.py

@@ -4,6 +4,7 @@ from adam.checks.check import Check
 from adam.checks.check_context import CheckContext
 from adam.checks.check_result import CheckResult
 from adam.checks.issue import Issue
+from adam.utils import Color
 from adam.utils_k8s.cassandra_nodes import CassandraNodes
 
 class Gossip(Check):
@@ -32,7 +33,7 @@ class Gossip(Check):
         #   TOKENS:21:<hidden>
         # STATUS line missing -> NORMAL
         # user, pw = get_user_pass(pod_name, ns)
-        result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"nodetool -u {ctx.user} -pw {ctx.pw} gossipinfo", show_out=ctx.show_output)
+        result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"nodetool -u {ctx.user} -pw {ctx.pw} gossipinfo", show_out=ctx.show_output, text_color=Color.gray)
 
         nodes = self.parse_gossipinfo(result.stdout)
         details = {

adam/checks/memory.py

@@ -2,6 +2,7 @@ from adam.checks.check import Check
 from adam.checks.check_context import CheckContext
 from adam.checks.check_result import CheckResult
 from adam.checks.issue import Issue
+from adam.utils import Color
 from adam.utils_k8s.cassandra_nodes import CassandraNodes
 from adam.utils_k8s.custom_resources import CustomResources
 from adam.utils_k8s.pods import Pods
@@ -47,7 +48,7 @@ class Memory(Check):
 
     def find_error(self, ctx: CheckContext, pattern: str, issue_desc: str):
         escaped = pattern.replace('"', '\"')
-        result = CassandraNodes.exec(ctx.pod, ctx.namespace, f'tac /c3/cassandra/logs/system.log | grep "{escaped}" | head -1', show_out=ctx.show_output)
+        result = CassandraNodes.exec(ctx.pod, ctx.namespace, f'tac /c3/cassandra/logs/system.log | grep "{escaped}" | head -1', show_out=ctx.show_output, text_color=Color.gray)
         if result.stdout.find(pattern) > 0:
             return Issue(
                 statefulset=ctx.statefulset,

adam/checks/status.py

@@ -4,6 +4,7 @@ from adam.checks.check import Check
 from adam.checks.check_context import CheckContext
 from adam.checks.check_result import CheckResult
 from adam.checks.issue import Issue
+from adam.utils import Color
 from adam.utils_k8s.cassandra_nodes import CassandraNodes
 
 class Status(Check):
@@ -14,7 +15,7 @@ class Status(Check):
         issues: list[Issue] = []
 
         try:
-            result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"nodetool -u {ctx.user} -pw {ctx.pw} status", show_out=ctx.show_output)
+            result = CassandraNodes.exec(ctx.pod, ctx.namespace, f"nodetool -u {ctx.user} -pw {ctx.pw} status", show_out=ctx.show_output, text_color=Color.gray)
             status = parse_nodetool_status(result.stdout)
             pod_details = {
                 'name': ctx.pod,

adam/commands/app/app.py

@@ -34,5 +34,5 @@ class App(Command):
     def completion(self, _: ReplState):
         return {}
 
-    def help(self, _: ReplState):
-        return f"<AppType>.<AppAction> <args> [--force]\t post app action; check with 'show app actions' command"
+    def help(self, state: ReplState):
+        return super().help(state, "post app action  use 'show app actions' for registered actions  --force refresh session", command='<AppType>.<AppAction>', args='<args> [--force]')

adam/commands/app/app_ping.py

@@ -34,5 +34,5 @@ class AppPing(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {'--force': None})
 
-    def help(self, _: ReplState):
-        return f"{AppPing.COMMAND} [--force]\t ping app server with Echo.echoStatic()"
+    def help(self, state: ReplState):
+        return super().help(state, 'ping app server with Echo.echoStatic() --force refresh session', args='[--force]')

adam/commands/app/login.py

@@ -63,5 +63,5 @@ class Login(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f'{Login.COMMAND}\t SSO login'
+    def help(self, state: ReplState):
+        return super().help(state, 'SSO login')

adam/commands/app/show_app_actions.py

@@ -45,5 +45,5 @@ class ShowAppActions(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f"{ShowAppActions.COMMAND}\t show app actions"
+    def help(self, state: ReplState):
+        return super().help(state, 'show registered app actions')

adam/commands/app/show_app_id.py

@@ -40,5 +40,5 @@ class ShowAppId(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f'{ShowAppId.COMMAND}\t show app id for the Cassandra cluster'
+    def help(self, state: ReplState):
+        return super().help(state, 'show app id for the Cassandra cluster')

adam/commands/app/show_app_queues.py

@@ -34,5 +34,5 @@ class ShowAppQueues(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {'--force': None})
 
-    def help(self, _: ReplState):
-        return f"{ShowAppQueues.COMMAND} [--force]\t show invalidation queue counts"
+    def help(self, state: ReplState):
+        return super().help(state, 'show invalidation queue counts  --force refresh session', args='[--force]')

adam/commands/app/show_login.py

@@ -52,5 +52,5 @@ class ShowLogin(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f'{ShowLogin.COMMAND}\t show login details'
+    def help(self, state: ReplState):
+        return super().help(state, 'show SSO login details')

adam/commands/audit/audit.py

@@ -7,12 +7,10 @@ from adam.commands.audit.audit_run import AuditRun
 from adam.commands.audit.show_last10 import ShowLast10
 from adam.commands.audit.show_slow10 import ShowSlow10
 from adam.commands.audit.show_top10 import ShowTop10
-from adam.commands.audit.utils_show_top10 import show_top10_completions_for_nesting
 from adam.commands.command import Command
 from adam.commands.intermediate_command import IntermediateCommand
 from adam.repl_state import ReplState
-from adam.sql.lark_completer import LarkCompleter
-from adam.utils import log2, wait_log
+from adam.utils import log2
 from adam.utils_athena import Athena
 
 class Audit(IntermediateCommand):
@@ -59,8 +57,8 @@ class Audit(IntermediateCommand):
     def cmd_list(self):
         return [AuditRepairTables(), AuditRun(), ShowLast10(), ShowSlow10(), ShowTop10()]
 
-    def help(self, _: ReplState):
-        return f'[{Audit.COMMAND}] [<sql-statements>]\t run SQL queries on Authena audit database'
+    def help(self, state: ReplState):
+        return super().help(state, 'run SQL queries on Athena audit database', command='[audit] [<sql-statements>]')
 
 class AuditCommandHelper(click.Command):
     def get_help(self, ctx: click.Context):

adam/commands/audit/audit_repair_tables.py

@@ -68,5 +68,5 @@ class AuditRepairTables(Command):
                 exec.submit(Athena.query, f'MSCK REPAIR TABLE {table}', None,)
             exec.submit(Audits.put_meta, Audits.PARTITIONS_ADDED, meta,)
 
-    def help(self, _: ReplState):
-        return f"{AuditRepairTables.COMMAND}\t run MSCK REPAIR command for new partition discovery"
+    def help(self, state: ReplState):
+        return super().help(state, 'run MSCK REPAIR to discover new partitions')

adam/commands/audit/audit_run.py

@@ -46,5 +46,5 @@ class AuditRun(Command):
     def completion(self, state: ReplState):
         return {}
 
-    def help(self, _: ReplState):
-        return f"{AuditRun.COMMAND}\t run"
+    def help(self, state: ReplState):
+        return super().help(state, 'run audit')

adam/commands/audit/show_last10.py

@@ -32,5 +32,5 @@ class ShowLast10(Command):
     def completion(self, _: ReplState):
         return {}
 
-    def help(self, _: ReplState):
-        return f'{ShowLast10.COMMAND} [limit]\t show last <limit> audit lines'
+    def help(self, state: ReplState):
+        return super().help(state, 'show last <limit> audit lines  <limit> defaults to 10', args='[limit]')

adam/commands/audit/show_slow10.py

@@ -32,5 +32,5 @@ class ShowSlow10(Command):
     def completion(self, _: ReplState):
         return {}
 
-    def help(self, _: ReplState):
-        return f'{ShowSlow10.COMMAND} [limit]\t show slow <limit> audit lines'
+    def help(self, state: ReplState):
+        return super().help(state, 'show slow <limit> audit lines  <limit> default to 10', args='[limit]')

adam/commands/audit/show_top10.py

@@ -32,5 +32,5 @@ class ShowTop10(Command):
     def completion(self, _: ReplState):
         return {}
 
-    def help(self, _: ReplState):
-        return f'{ShowTop10.COMMAND} [limit]\t show top <limit> audit lines'
+    def help(self, state: ReplState):
+        return super().help(state, 'show top <limit> audit lines  <limit> default to 10', args='[limit]')

adam/commands/bash/bash.py

@@ -32,5 +32,5 @@ class Bash(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {c : {'&': None} for c in ['ls', 'cat', 'head']}, pods=Devices.of(state).pods(state, '-'))
 
-    def help(self, _: ReplState):
-        return f'{Bash.COMMAND} [pod-name] [bash-commands] [&]\t run bash on the Cassandra nodes'
+    def help(self, state: ReplState):
+        return super().help(state, 'run bash on Cassandra nodes', args='[bash-commands] [&]')

adam/commands/cassandra/download_cassandra_log.py

@@ -41,5 +41,5 @@ class DownloadCassandraLog(Command):
     def completion(self, state: ReplState):
         return super().completion(state, pods=Devices.of(state).pods(state, '-'), auto='jit')
 
-    def help(self, _: ReplState):
-        return f'{DownloadCassandraLog.COMMAND}\t download cassandra system log'
+    def help(self, state: ReplState):
+        return super().help(state, 'download cassandra system log')

adam/commands/cassandra/restart_cluster.py

@@ -43,5 +43,5 @@ class RestartCluster(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {'--force': None})
 
-    def help(self, _: ReplState):
-        return f"{RestartCluster.COMMAND} --force\t restart all the nodes in the cluster"
+    def help(self, state: ReplState):
+        return super().help(state, 'restart all the nodes in the cluster', args='--force')

adam/commands/cassandra/restart_node.py

@@ -47,5 +47,5 @@ class RestartNode(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {'--force': None}, pods=Devices.of(state).pods(state, '-'))
 
-    def help(self, _: ReplState):
-        return f"{RestartNode.COMMAND} --force\t restart the node"
+    def help(self, state: ReplState):
+        return super().help(state, 'restart the node', args='--force')

adam/commands/cassandra/restart_nodes.py

@@ -43,5 +43,5 @@ class RestartNodes(Command):
     def completion(self, state: ReplState):
         return super().completion(state, lambda: {p: {'--force': None} for p in StatefulSets.pod_names(state.sts, state.namespace)})
 
-    def help(self, _: ReplState):
-        return f"{RestartNodes.COMMAND} <pod-name>... --force\t restart Cassandra nodes"
+    def help(self, state: ReplState):
+        return super().help(state, 'restart Cassandra nodes', args='<pod-name>... --force')

adam/commands/cassandra/rollout.py

@@ -84,5 +84,5 @@ class RollOut(Command):
 
         return {}
 
-    def help(self, _: ReplState):
-        return f'{RollOut.COMMAND} [--force]\t rollout all nodes'
+    def help(self, state: ReplState):
+        return super().help(state, 'rollout all nodes  --force ignore current rolling out', args='[--force]')

adam/commands/cassandra/show_cassandra_repairs.py

@@ -33,5 +33,5 @@ class ShowCassandraRepairs(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {'&': None})
 
-    def help(self, _: ReplState):
-        return f'{ShowCassandraRepairs.COMMAND}\t show Cassandra repairs'
+    def help(self, state: ReplState):
+        return super().help(state, 'show Cassandra repairs', args='[&]')

adam/commands/cassandra/show_cassandra_status.py

@@ -113,5 +113,5 @@ class ShowCassandraStatus(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {'-s': {'&': None}, '&': None})
 
-    def help(self, _: ReplState):
-        return f'{ShowCassandraStatus.COMMAND} [-s]\t show merged nodetool status  -s show commands on nodes'
+    def help(self, state: ReplState):
+        return super().help(state, 'show merged nodetool status  -s show processing details', args='[-s]')

adam/commands/cassandra/show_cassandra_version.py

@@ -31,5 +31,5 @@ class ShowCassandraVersion(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f'{ShowCassandraVersion.COMMAND}\t show Cassandra version'
+    def help(self, state: ReplState):
+        return super().help(state, 'show Cassandra version')

adam/commands/cassandra/show_processes.py

@@ -29,12 +29,12 @@ class ShowProcesses(Command):
         with self.validate(args, state) as (args, state):
             with extract_trailing_options(args, '&') as (args, backgrounded):
                 with extract_options(args, ['-s', '--show']) as (args, show_out):
-                    with extract_sequence(args, ['with', 'recipe', '=', 'qing']) as (_, recipe_qing):
+                    with extract_sequence(args, ['with', 'recipe', '=', 'mpstat']) as (_, recipe_qing):
                         cols = Config().get('processes.columns', 'pod,cpu-metrics,mem')
                         header = Config().get('processes.header', 'POD_NAME,M_CPU(USAGE/LIMIT),MEM/LIMIT')
                         if recipe_qing:
-                            cols = Config().get('processes-qing.columns', 'pod,cpu,mem')
-                            header = Config().get('processes-qing.header', 'POD_NAME,Q_CPU/TOTAL,MEM/LIMIT')
+                            cols = Config().get('processes-mpstat.columns', 'pod,cpu,mem')
+                            header = Config().get('processes-mpstat.header', 'POD_NAME,Q_CPU/TOTAL,MEM/LIMIT')
 
                     with cassandra(state) as pods:
                         pods.display_table(cols, header, show_out=show_out, backgrounded=backgrounded, msg='Checking processes')
@@ -42,9 +42,9 @@ class ShowProcesses(Command):
                     return state
 
     def completion(self, state: ReplState):
-        recipes = ['metrics', 'qing']
+        recipes = ['metrics', 'mpstat']
         return super().completion(state, {'with': {'recipe': {'=': {r: {'-s': {'&': None}, '&': None} for r in recipes}}}, '-s': {'&': None}, '&': None})
         # return super().completion(state, {'with': {'recipe': {'=': {'metrics': {'-s': {'&': None}, '&': None}, 'qing': {'-s': {'&': None}}}}}, '-s': {'&': None}, '&': None})
 
-    def help(self, _: ReplState):
-        return f'{ShowProcesses.COMMAND} [with recipe qing|metrics] [-s]\t show process overview  -s show commands on nodes'
+    def help(self, state: ReplState):
+        return super().help(state, 'show process overview  -s show processing details', args='[with recipe=metrics|mpstat] [-s]')

adam/commands/cassandra/show_storage.py

@@ -40,5 +40,5 @@ class ShowStorage(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {'-s': {'&': None}, '&': None})
 
-    def help(self, _: ReplState):
-        return f'{ShowStorage.COMMAND} [-s]\t show storage overview  -s show commands on nodes'
+    def help(self, state: ReplState):
+        return super().help(state, 'show storage overview  -s show processing details', args='[-s]')

adam/commands/cassandra/watch.py

@@ -78,5 +78,5 @@ class Watch(Command):
 
         return {}
 
-    def help(self, _: ReplState):
-        return f'{Watch.COMMAND}\t watch Cassandra pod changes'
+    def help(self, state: ReplState):
+        return super().help(state, 'watch Cassandra pod changes')

adam/commands/cli/clipboard_copy.py

@@ -64,8 +64,8 @@ class ClipboardCopy(Command):
     def completion(self, state: ReplState):
         return super().completion(state, lambda: {key: None for key in CliCommands.values(state).keys()}, auto_key='cli.cp-auto-complete')
 
-    def help(self, _: ReplState):
-        return f"{ClipboardCopy.COMMAND} <key>\t copy a value to clipboard for conveninence"
+    def help(self, state: ReplState):
+        return super().help(state, 'copy a value to clipboard for conveninence', args='<key')
 
 class CopyCommandHelper(click.Command):
     def lines(self):

adam/commands/cli/show_cli_commands.py

@@ -1,7 +1,7 @@
 from adam.commands.cli.cli_commands import CliCommands
 from adam.commands.command import Command
 from adam.repl_state import ReplState, RequiredState
-from adam.utils import tabulize, log
+from adam.utils import tabulize
 
 class ShowKubectlCommands(Command):
     COMMAND = 'show cli-commands'
@@ -52,5 +52,5 @@ class ShowKubectlCommands(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f"{ShowKubectlCommands.COMMAND}\t show kubectl commands"
+    def help(self, state: ReplState):
+        return super().help(state, 'show kubectl commands')

adam/commands/code.py

@@ -53,5 +53,5 @@ class Code(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f'{Code.COMMAND} \t invoke interactive Python shell'
+    def help(self, state: ReplState):
+        return super().help(state, 'run interactive Python shell')

adam/commands/command.py

@@ -22,6 +22,9 @@ class Command:
     def command(self) -> str:
         pass
 
+    def aliases(self):
+        return None
+
     # The chain of responsibility pattern
     # Do not do child of child!!!
     @abstractmethod
@@ -68,6 +71,13 @@ class Command:
         for t in reversed(self.command().split(' ')):
             d = {t: d}
 
+        if aliases := self.aliases():
+            for alias in aliases:
+                a = leaf
+                for t in reversed(alias.split(' ')):
+                    a = {t: a}
+                d |= a
+
         return d
 
     def required(self) -> RequiredState:
@@ -79,16 +89,33 @@ class Command:
     def validate_state(self, state: ReplState, show_err = True):
         return state.validate(self.required(), show_err=show_err)
 
-    def help(self, _: ReplState) -> str:
-        return None
+    def help(self, _: ReplState, desc: str = None, command: str = None, args: str = None):
+        if not desc:
+            return None
+
+        if not command:
+            command = self.command()
+        if args:
+            args = f' {args}'
+        else:
+            args = ''
+        aliases = '  alias ' + ','.join(self.aliases()) if self.aliases() else ''
+        return f'{command}{args}{aliases}\t{desc}'
 
     def args(self, cmd: str):
         a = list(filter(None, cmd.split(' ')))
         spec = self.command_tokens()
-        if spec != a[:len(spec)]:
-            return None
+        if spec == a[:len(spec)]:
+            return a
 
-        return a
+        if aliases := self.aliases():
+            for alias in aliases:
+                a = list(filter(None, cmd.split(' ')))
+                spec = alias.split(' ')
+                if spec == a[:len(spec)]:
+                    return a
+
+        return None
 
     def apply_state(self, args: list[str], state: ReplState, resolve_pg = True, args_to_check = 6) -> tuple[ReplState, list[str]]:
         """

adam/commands/config/param_get.py

@@ -38,5 +38,5 @@ class GetParam(Command):
     def completion(self, _: ReplState):
         return {GetParam.COMMAND: {key: None for key in Config().keys()}}
 
-    def help(self, _: ReplState):
-        return f"{GetParam.COMMAND} <key>\t shows a Kaqing parameter"
+    def help(self, state: ReplState):
+        return super().help(state, "shows a Kaqing system parameter's value", args='<key>')

adam/commands/config/param_set.py

@@ -36,5 +36,5 @@ class SetParam(Command):
     def completion(self, _: ReplState):
         return {SetParam.COMMAND: {key: ({'true': None, 'false': None} if Config().get(key, None) in [True, False] else None) for key in Config().keys()}}
 
-    def help(self, _: ReplState):
-        return f"{SetParam.COMMAND} <key> <value>\t sets a Kaqing parameter to a different value"
+    def help(self, state: ReplState):
+        return super().help(state, 'sets a Kaqing system parameter to a different value', args='<key> <value>')

adam/commands/config/show_params.py

@@ -27,5 +27,5 @@ class ShowParams(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f"{ShowParams.COMMAND}\t show Kaqing parameters"
+    def help(self, state: ReplState):
+        return super().help(state, 'show Kaqing system parameters')

adam/commands/cql/alter_tables.py

@@ -62,5 +62,5 @@ class AlterTables(Command):
         # auto completion is taken care of by lark completer
         return {}
 
-    def help(self, _: ReplState) -> str:
-        return f'{AlterTables.COMMAND} <param = value> [--include-reaper] \t alter schema on all tables'
+    def help(self, state: ReplState) -> str:
+        return super().help(state, 'alter schema on all tables', args='with <param=value>,... [--include-reaper]')

adam/commands/cql/cqlsh.py

@@ -44,8 +44,8 @@ class Cqlsh(Command):
 
         return {}
 
-    def help(self, _: ReplState) -> str:
-        return f'<cql-statements> [&]\t run cqlsh with queries'
+    def help(self, state: ReplState) -> str:
+        return super().help(state, 'run cqlsh with queries', command='[cql] <cql-statement>;...', args='[&]')
 
 class CqlCommandHelper(click.Command):
     def get_help(self, ctx: click.Context):

adam/commands/cql/utils_cql.py

@@ -227,16 +227,26 @@ class CassandraPodService:
     def __init__(self, handler: 'CassandraExecHandler'):
         self.handler = handler
 
-    def exec(self, command: str, action='bash', show_out = True, on_any = False, throw_err = False, shell = '/bin/sh', backgrounded = False, log_file = None, history=True) -> Union[PodExecResult, list[PodExecResult]]:
+    def exec(self,
+             command: str,
+             action='bash',
+             show_out = True,
+             on_any = False,
+             throw_err = False,
+             shell = '/bin/sh',
+             backgrounded = False,
+             log_file = None,
+             history=True,
+             text_color: str = None) -> Union[PodExecResult, list[PodExecResult]]:
         state = self.handler.state
         pod = self.handler.pod
 
         if pod:
             return CassandraNodes.exec(pod, state.namespace, command,
-                                    show_out=show_out, throw_err=throw_err, shell=shell, backgrounded=backgrounded, log_file=log_file, history=history)
+                                    show_out=show_out, throw_err=throw_err, shell=shell, backgrounded=backgrounded, log_file=log_file, history=history, text_color=text_color)
         elif state.sts:
             return CassandraClusters.exec(state.sts, state.namespace, command, action=action,
-                                        show_out=show_out, on_any=on_any, shell=shell, backgrounded=backgrounded, log_file=log_file, history=history)
+                                        show_out=show_out, on_any=on_any, shell=shell, backgrounded=backgrounded, log_file=log_file, history=history, text_color=text_color)
 
         return []
 

adam/commands/debug/debug_completes.py

@@ -31,5 +31,5 @@ class DebugCompletes(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {f: None for f in ['on', 'off', 'file']})
 
-    def help(self, _: ReplState):
-        return f'{DebugCompletes.COMMAND} on|off|file\t turn auto complete debug on or off'
+    def help(self, state: ReplState):
+        return super().help(state, 'turn auto complete debug on or off', args='on|off|file')

adam/commands/debug/debug_timings.py

@@ -31,5 +31,5 @@ class DebugTimings(Command):
     def completion(self, state: ReplState):
         return super().completion(state, {f: None for f in ['on', 'off', 'file']})
 
-    def help(self, _: ReplState):
-        return f'{DebugTimings.COMMAND} on|off|file\t turn timing debug on or off'
+    def help(self, state: ReplState):
+        return super().help(state, 'turn timing debug on or off', args='on|off|file')

adam/commands/debug/show_offloaded_completes.py

@@ -41,5 +41,5 @@ class ShowOffloadedCompletes(Command):
     def completion(self, state: ReplState):
         return super().completion(state)
 
-    def help(self, _: ReplState):
-        return f'{ShowOffloadedCompletes.COMMAND}\t show offloaded completes'
+    def help(self, state: ReplState):
+        return super().help(state, 'show offloaded completes')

adam/commands/deploy/code_start.py

@@ -42,5 +42,5 @@ class CodeStart(Command):
 
         return {}
 
-    def help(self, _: ReplState):
-        return f'{CodeStart.COMMAND}\t start code server'
+    def help(self, state: ReplState):
+        return super().help(state, 'start code server')