Skip to content

Refresh mesheryctl top-level command summaries for clarity #16691

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.

Sign up for GitHub

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

Jump to bottom
Merged
jamieplu merged 5 commits into from
Dec 18, 2025
Merged

Refresh mesheryctl top-level command summaries for clarity #16691

jamieplu merged 5 commits into from
Dec 18, 2025

Conversation

Copy link
Contributor

Copilot AI commented Dec 18, 2025 •
edited
Loading

Updated mesheryctl’s root help text to use clearer, action-oriented short descriptions for all top-level commands (adapter, completion, component, connection, design, environment, exp, filter, model, perf, registry, system, version), and aligned the help command label.

  • Summary of issue: Top-level mesheryctl commands exposed vague or inconsistent short descriptions in mesheryctl --help.
  • Changes:
    • Refined Short strings for each root subcommand to concise, task-focused phrasing (e.g., “Manage service mesh adapters”, “Run performance tests”, “Manage Meshery deployment”).
    • Added a custom help command entry to display the updated help label.
  • Example (updated help excerpt): 
    Available Commands:
  adapter     Manage service mesh adapters
  perf        Run performance tests
  registry    Manage the capability registry
  system      Manage Meshery deployment
  version     Show mesheryctl version

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • docs.meshery.io
    • Triggering command: /tmp/go-build1943500469/b2263/root.test /tmp/go-build1943500469/b2263/root.test -test.testlogfile=/tmp/go-build1943500469/b2263/testlog.txt -test.paniconexit0 -test.timeout=10m0s -m elf_x86_64 --hash-style=gnu --as-needed -export-dynamic -dynamic-linker /lib64/ld-linux-x86-64.so.2 -z -ato�� -bool -buildtags x64/pkg/tool/lin-nilfunc -errorsas -ifaceassert -nilfunc x64/pkg/tool/lin-plugin-opt=/usr/libexec/gcc/x86_64-linux-gnu/13/lto-wrapper (dns block)
    • Triggering command: /tmp/go-build1943500469/b2302/system.test /tmp/go-build1943500469/b2302/system.test -test.testlogfile=/tmp/go-build1943500469/b2302/testlog.txt -test.paniconexit0 -test.timeout=10m0s -ato�� -bool -buildtags x64/pkg/tool/lin-nilfunc -errorsas -ifaceassert -nilfunc x64/pkg/tool/lin/tmp/ccwHarOl.o -ato�� -bool -buildtags x64/pkg/tool/linux_amd64/vet -errorsas -ifaceassert -nilfunc x64/pkg/tool/lin/tmp/ccA38F7t.o (dns block)
    • Triggering command: /tmp/go-build2684087875/b2302/system.test /tmp/go-build2684087875/b2302/system.test -test.testlogfile=/tmp/go-build2684087875/b2302/testlog.txt -test.paniconexit0 -test.timeout=10m0s -ato�� kg_.a -buildtags /x86_64-linux-gn/tmp/go-build2684087875/b2277/design.test -errorsas ryctl/internal/c--64 -nilfunc /x86_64-linux-gn/tmp/cc0xYFHa.o --no�� 7CDY5M6mT (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Rewrite the short descriptions for these commands:

Available Commands:
adapter Cloud Native Lifecycle Management
completion Output shell completion code
component Manage components
connection Manage Meshery connection
design Cloud Native Designs Management
environment View list of environments and detail of environments
exp Experimental commands for mesheryctl
filter Cloud Native Filter Management
help Help about any command
model Manage models
perf Performance Management
registry Model Database
system Meshery Lifecycle Management
version Version of mesheryctl

Custom agent used: Meshery Code Contributor
Expert-level software engineering agent specialized in contributing to Meshery's cloud native infrastructure and application management platform.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@carlosriosilva carlosriosilva marked this pull request as ready for review December 18, 2025 05:39
@github-actions
Copy link

github-actions bot commented Dec 18, 2025 •
edited
Loading

View in catalog, Edit in playground or learn how to interpret Meshery Designs

@ritzorama
chore: refresh mesheryctl command descriptions
d1ff005 
Co-authored-by: ritzorama <182301570+ritzorama@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor command descriptions for clarity Refresh mesheryctl top-level command summaries for clarity Dec 18, 2025
Copilot AI requested a review from ritzorama December 18, 2025 06:02
leecalcote
leecalcote previously approved these changes Dec 18, 2025
View reviewed changes
@jamieplu @leecalcote
Update mesheryctl/internal/cli/root/model/model.go
b6d55e1 
Co-authored-by: Lee Calcote <lee.calcote@layer5.io>
Signed-off-by: jamieplu <179417684+jamieplu@users.noreply.github.com>
@github-actions github-actions bot added the component/mesheryctl CLI for Meshery label Dec 18, 2025
@jamieplu @leecalcote
Apply suggestions from code review
c953423 
Co-authored-by: Lee Calcote <lee.calcote@layer5.io>
Signed-off-by: jamieplu <179417684+jamieplu@users.noreply.github.com>
@jamieplu jamieplu merged commit 904870b into master Dec 18, 2025
7 of 8 checks passed
@jamieplu jamieplu deleted the copilot/update-command-descriptions branch December 18, 2025 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jamieplu jamieplu jamieplu approved these changes

@leecalcote leecalcote leecalcote left review comments

@ritzorama ritzorama Awaiting requested review from ritzorama

Assignees

@ritzorama ritzorama

Copilot code review Copilot

Labels

component/mesheryctl CLI for Meshery

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@leecalcote @jamieplu @ritzorama @carlosriosilva