Skip to content

Update CLI help command output UX #12015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Conversation

gtsiolis
Copy link
Member

Motivation

Some UX updates in the help output.

⚠️ May contain non-optimized Python code. 🐍

Changes

BEFORE AFTER
Screenshot 2024-12-11 at 00 42 23 Screenshot 2024-12-11 at 00 42 17

@gtsiolis
Copy link
Member Author

❓ I realized this will only update the sections on the top-level help output. Could we apply this section styling to all sections for nested commands? If that's too much trouble, let's close the PR.

-h pod -h
Screenshot 2024-12-11 at 00 48 22 Screenshot 2024-12-11 at 00 48 33

@gtsiolis gtsiolis force-pushed the gt/update-help-output branch from 800c243 to cd6ee2e Compare December 10, 2024 22:50
Copy link

LocalStack Community integration with Pro

    2 files  ±0      2 suites  ±0   1h 51m 16s ⏱️ - 1m 14s
3 881 tests ±0  3 565 ✅ ±0  316 💤 ±0  0 ❌ ±0 
3 883 runs  ±0  3 565 ✅ ±0  318 💤 ±0  0 ❌ ±0 

Results for commit cd6ee2e. ± Comparison against base commit abb35c3.

Copy link
Member

@alexrashed alexrashed left a comment

Choose a reason for hiding this comment

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

I had a quick dive into click and how this works, and apparently this isn't super-straight forward to implement.
You modified the LocalStackCliGroup, which means it only applies to CLI groups which explicitly define to use this class.
However, there also are:

  • Groups that do not explicitly define that this specific group class should be used.
  • Commands, which are not groups, which show a similar help message, where we do not have a custom implementation yet.
  • Other custom group classes (like the one for pods) which needs to be modified such that it inherits from this group class.

If you want we can try to take a quick dive together, but I am afraid this will take you some time to implement globally in the CLI...

@gtsiolis gtsiolis added this to the Playground milestone Jan 21, 2025
@gtsiolis
Copy link
Member Author

gtsiolis commented May 6, 2025

@alexrashed Following up from a discussion a few weeks ago, feel free to take this over or close the PR. Happy to assist with more design specs if needed. 🏓

Low priority! 🔅

@alexrashed alexrashed marked this pull request as draft May 14, 2025 15:18
@gtsiolis gtsiolis changed the title Update help command output UX Update CLI help command output UX May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants