fix: Add default values to CLI flag help text #3166

majiayu000 · 2025-12-27T08:44:14Z

Summary

This PR fixes #3049

Changes

cmd/thv/app/auth_flags.go
cmd/thv/app/list.go
cmd/thv/app/rm.go
cmd/thv/app/run_flags.go
cmd/thv/app/stop.go

Add default values to flag descriptions for improved user experience. This provides better visibility into default behavior when viewing help text for various CLI commands including run, list, stop, and rm. The pattern "(default: X)" is added consistently to flag descriptions where meaningful defaults exist. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]> Signed-off-by: majiayu000 <[email protected]>

eleftherias

Thanks for the PR @majiayu000. As I was reviewing it I noticed many of these changes are not needed because Cobra will automatically add the default value to the description.
Instead of adding (default: X) everywhere, could you run thv run --help, thv list ---help etc, and verify that the default value is not already listed?

Note that I've called out some cases where the change is not needed in the comments below, but I have not listed every single one.

eleftherias · 2026-01-02T09:08:47Z

cmd/thv/app/auth_flags.go

-		"Skip opening browser for remote server OAuth flow")
+		"Skip opening browser for remote server OAuth flow (default: false)")
 	cmd.Flags().DurationVar(&config.RemoteAuthTimeout, "remote-auth-timeout", 30*time.Second,
-		"Timeout for OAuth authentication flow (e.g., 30s, 1m, 2m30s)")


This change is not needed. If you run thv run --help you will see that Cobra shows the default value in the description. Cobra will do this when the default value is something other than false.

eleftherias · 2026-01-02T09:09:09Z

cmd/thv/app/auth_flags.go

+		"Timeout for OAuth authentication flow (e.g., 30s, 1m, 2m30s) (default: 30s)")
 	cmd.Flags().IntVar(&config.RemoteAuthCallbackPort, "remote-auth-callback-port", runner.DefaultCallbackPort,
-		"Port for OAuth callback server during remote authentication")
+		"Port for OAuth callback server during remote authentication (default: 8666)")


This change is not needed. If you run thv run --help you will see that Cobra shows the default value in the description.

eleftherias · 2026-01-02T09:09:35Z

cmd/thv/app/list.go

-	listCmd.Flags().BoolVarP(&listAll, "all", "a", false, "Show all workloads (default shows just running)")
-	listCmd.Flags().StringVar(&listFormat, "format", FormatText, "Output format (json, text, or mcpservers)")
+	listCmd.Flags().BoolVarP(&listAll, "all", "a", false, "Show all workloads (default shows just running) (default: false)")
+	listCmd.Flags().StringVar(&listFormat, "format", FormatText, "Output format (json, text, or mcpservers) (default: text)")


This change is not needed. If you run thv list --help you will see that Cobra shows the default value in the description.

eleftherias · 2026-01-02T09:09:58Z

cmd/thv/app/run_flags.go

 		"proxy-mode",
 		"streamable-http",
-		"Proxy mode for stdio (streamable-http or sse (deprecated, will be removed))")
+		"Proxy mode for stdio (streamable-http or sse (deprecated, will be removed)) (default: streamable-http)")


This change is not needed. If you run thv run --help you will see that Cobra shows the default value in the description.

dmjb · 2026-01-13T12:08:32Z

@majiayu000 Let us know if you plan on addressing some of the feedback raised above.

…t-values-to-cli-flag-help-text

codecov · 2026-01-13T16:23:53Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.67%. Comparing base (bc0d112) to head (99ffab0).
⚠️ Report is 19 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3166      +/-   ##
==========================================
+ Coverage   63.64%   63.67%   +0.03%     
==========================================
  Files         361      361              
  Lines       35449    35449              
==========================================
+ Hits        22560    22571      +11     
+ Misses      11082    11063      -19     
- Partials     1807     1815       +8

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

majiayu000 · 2026-01-13T16:39:14Z

Thanks for the feedback @eleftherias. I've synced with main and removed the redundant default values from the flag descriptions, as Cobra adds them automatically. I also resolved the merge conflicts with the recent upstream changes. Ready for review!

majiayu000 · 2026-01-13T16:40:27Z

@majiayu000 Let us know if you plan on addressing some of the feedback raised above.

Thanks for the reminder. I was too busy this time. Feel free to close this pr if also questionable.

eleftherias · 2026-01-15T13:05:35Z

Thanks for the reminder. I was too busy this time. Feel free to close this pr if also questionable.

Looking at the updates it seems like no new defaults were added and that one of the defaults was removed. I'll go ahead and close this PR since it's removing some of the functionality we want.

eleftherias requested changes Jan 2, 2026

View reviewed changes

majiayu000 added 2 commits January 14, 2026 00:10

fix: remove redundant default values from flag descriptions

e47cb21

Merge remote-tracking branch 'upstream/main' into fix-3049-add-defaul…

c46d119

…t-values-to-cli-flag-help-text

github-actions bot added the size/XS Extra small PR: < 100 lines changed label Jan 13, 2026

github-actions bot added size/XS Extra small PR: < 100 lines changed and removed size/XS Extra small PR: < 100 lines changed labels Jan 13, 2026

docs: regenerate CLI docs

99ffab0

majiayu000 force-pushed the fix-3049-add-default-values-to-cli-flag-help-text branch from e9d28e6 to 99ffab0 Compare January 13, 2026 16:45

github-actions bot added size/XS Extra small PR: < 100 lines changed and removed size/XS Extra small PR: < 100 lines changed labels Jan 13, 2026

amirejaz requested a review from eleftherias January 15, 2026 12:50

eleftherias closed this Jan 15, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Add default values to CLI flag help text #3166

fix: Add default values to CLI flag help text #3166

Uh oh!

majiayu000 commented Dec 27, 2025

Uh oh!

eleftherias left a comment

Uh oh!

eleftherias Jan 2, 2026

Uh oh!

eleftherias Jan 2, 2026

Uh oh!

eleftherias Jan 2, 2026

Uh oh!

eleftherias Jan 2, 2026

Uh oh!

dmjb commented Jan 13, 2026

Uh oh!

codecov bot commented Jan 13, 2026 •

edited

Loading

Uh oh!

majiayu000 commented Jan 13, 2026

Uh oh!

majiayu000 commented Jan 13, 2026

Uh oh!

eleftherias commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

fix: Add default values to CLI flag help text #3166

fix: Add default values to CLI flag help text #3166

Uh oh!

Conversation

majiayu000 commented Dec 27, 2025

Summary

Changes

Uh oh!

eleftherias left a comment

Choose a reason for hiding this comment

Uh oh!

eleftherias Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

eleftherias Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

eleftherias Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

eleftherias Jan 2, 2026

Choose a reason for hiding this comment

Uh oh!

dmjb commented Jan 13, 2026

Uh oh!

codecov bot commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

majiayu000 commented Jan 13, 2026

Uh oh!

majiayu000 commented Jan 13, 2026

Uh oh!

eleftherias commented Jan 15, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Jan 13, 2026 •

edited

Loading