You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Arguments and flags of support-bundle and analyze CLI applications are slightly inconsistent. This can lead to users getting confused.
All commands follow a <cmd> <args> <flags> format as below
[evans] $<cmd> -h
Short description of what the command does
Usage:
<cmd> [url] [flags]
<cmd> [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
help Help about any command
version Print the current version and exit
Flags:
<bunch of flags>
support-bundle and analyze have some options that are misleading/confusing
support-bundle
There is a analyze command which does the same thing as analyze CLI.
Usage:
support-bundle [url] [flags]
support-bundle [command]
Available Commands:
analyze analyze a support bundle
...
Flags:
...
analyze analyze CLI is missing Available Commands: that the rest have. There is also an additional --analyzers flag that does the same thing as the [url] argument.
Usage:
analyze [url] [flags]
Flags:
--analyzers string filename or url of the analyzers to use
Describe the feature
support-bundle
We can choose to either remove the analyze sub-command and leave the analyze CLI or do the opposite. This opens a discussion of whether we want to consolidate all support bundle operations (analyze, redact, collect) as sub-commands in the support-bundle CLI.
banjoh
changed the title
Make arguments and options of cli applications consistent
Make arguments and flags of cli applications consistent
Dec 1, 2022
banjoh
changed the title
Make arguments and flags of cli applications consistent
Make arguments and flags of cli applications consistent and handle cli argument parsing errors better
Dec 1, 2022
banjoh
changed the title
Make arguments and flags of cli applications consistent and handle cli argument parsing errors better
Make arguments and flags of cli applications consistent
Dec 1, 2022
I think to maintain compatibility with folks currently using these CLIs, I'd like to roll this into a task to create a consolidated command line for the Troubleshoot project (#933 )
Describe the rationale for the suggested feature.
Arguments and flags of
support-bundle
andanalyze
CLI applications are slightly inconsistent. This can lead to users getting confused.All commands follow a
<cmd> <args> <flags>
format as belowsupport-bundle
andanalyze
have some options that are misleading/confusingThere is a
analyze
command which does the same thing asanalyze
CLI.analyze
CLI is missingAvailable Commands:
that the rest have. There is also an additional--analyzers
flag that does the same thing as the[url]
argument.Describe the feature
support-bundle
analyze
sub-command and leave theanalyze
CLI or do the opposite. This opens a discussion of whether we want to consolidate all support bundle operations (analyze, redact, collect) as sub-commands in thesupport-bundle
CLI.analyze
--analyzers
flag in favour of[urls]
Describe alternatives you've considered
Leave things as they are
Additional note
Should we deprecate the
collect
CLI application?support-bundle
runs collectors as well in addition to redacting and analysing.The text was updated successfully, but these errors were encountered: