Uploaded image for project: 'OpenShift Pipelines'
  1. OpenShift Pipelines
  2. SRVKP-9460

[tkn-assist] Show example to cmd usage in opc CLI

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: Normal Normal
    • None
    • None
    • Tekton CLI

      Description of problem:

      When running the help command for the assist plugin via the opc CLI, the top-level output lacks an Examples section to guide the user.

      Workaround

      opc assist taskrun -h
      Commands for diagnosing and analyzing Tekton TaskRuns.Usage:
      opc assist taskrun [command]
      Aliases:
        taskrun, tr, taskrunsExamples:
          # Diagnose a failed TaskRun
        tkn-assist taskrun diagnose my-failed-taskrunAvailable Commands:
        diagnose    Diagnose a TaskRun and provide AI-powered analysisFlags:
        -h, --help   help for taskrunUse "opc assist taskrun [command] --help" for more information about a command.
       

      Prerequisites (if any, like setup, operators/versions):

      1.21.0

      Steps to Reproduce

      • Download/Install the opc binary.
      • Run the command: opc assist
      • Observe that Example: section is displayed.
      • Run the command: opc assist taskrun -h
      • Observe the Examples section.

      Actual results:

       opc assist                     
      tkn plugin to use AI-assisted diagnosis for TektonUsage:
      opc assist [command]
      Available Commands:
        pipelinerun Commands for working with PipelineRuns
        taskrun     Commands for working with TaskRunsFlags:
        -h, --help   help for assistUse "opc assist [command] --help" for more information about a command. 

      Expected results:
      Examples:

      1. Diagnose a PipelineRun
        opc assist pipelinerun diagnose <pr-name>
        Examples:
      2. Diagnose a failed TaskRun
        opc assist taskrun diagnose <tr-name>

        Reproducibility (Always/Intermittent/Only Once):

      Always

      Additional info (Such as Logs, Screenshots, etc):

       

       *

              Unassigned Unassigned
              rhn-support-sselvan Sri Vignesh Selvan
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated: