Skip to content

cli: output of 'cockroach connect --help' is overwhelming #61611

Open
@knz

Description

@knz

When running cockroach connect --help there is a lot of output but no instruction given to the user about what they should be doing.

Would welcome:

  • under the "Usage" label at top, a few examples with concrete argument values and explanations (This is the Use field of the cobra.Command in the source)
  • also mention --single-node in the usage strings

cc @itsbilal @aaron-crl

part of #60632

Jira issue: CRDB-6276
Epic: CRDB-6663

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-authenticationPertains to authn subsystemsA-cli-adminCLI commands that pertain to controlling and configuring nodesA-docsC-bugCode not up to spec/doc, specs & docs deemed correct. Solution expected to change code/behavior.T-server-and-securityDB Server & Security

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions