Skip to content

fix(cli): correct linebreaks in command help. - #420

Merged
cloudsmith-iduffy merged 1 commit into
cloudsmith-io:masterfrom
nikshankarnoble:fix/cmd-help-linebreaks
Sep 17, 2026
Merged

cloudsmith-iduffy merged 1 commit into
cloudsmith-io:masterfrom
nikshankarnoble:fix/cmd-help-linebreaks

Conversation

@nikshankarnoble

Copy link
Copy Markdown
Contributor

Description

I noticed while using the CLI that a couple of the commands had some broken formatting while using --help due to Click's automatic line wrapping, so I've done a quick sweep and added the missing \b operator that disables wrapping (and fixed an issue with some \ characters not being escaped).

Before:
image

After:
image

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactoring
  • Other (please describe)

Additional Notes

This is my first contribution to this (or any Cloudsmith) so please let me know if there's anything I need to do/update!

Copilot AI lite review requested due to automatic review settings September 16, 2026 15:12
@nikshankarnoble
nikshankarnoble requested a review from a team as a code owner September 16, 2026 15:12

@cloudsmith-iduffy cloudsmith-iduffy left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes Click help formatting by preserving intended line breaks and escaping shell continuation characters.

Changes:

  • Adds no-wrap markers to command help.
  • Escapes multiline entitlement examples.
  • Updates MCP and credential-helper help formatting.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file
File Reviewed changes
cloudsmith_cli/cli/commands/metadata.py Preserves metadata help formatting.
cloudsmith_cli/cli/commands/mcp.py Preserves MCP configuration sections.
cloudsmith_cli/cli/commands/list_.py Preserves package sorting guidance.
cloudsmith_cli/cli/commands/entitlements.py Escapes shell continuation characters.
cloudsmith_cli/cli/commands/domains.py Preserves output documentation formatting.
cloudsmith_cli/cli/commands/credential_helper/terraform.py Formats Terraform examples.
cloudsmith_cli/cli/commands/credential_helper/docker.py Formats Docker helper sections.
cloudsmith_cli/cli/commands/credential_helper/__init__.py Formats helper group examples.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread cloudsmith_cli/cli/commands/credential_helper/__init__.py
Comment thread cloudsmith_cli/cli/commands/credential_helper/docker.py
Comment thread cloudsmith_cli/cli/commands/credential_helper/terraform.py
@cloudsmith-iduffy
cloudsmith-iduffy merged commit ac83389 into cloudsmith-io:master Sep 17, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants