Improve CLI help text: I/O contract, dynamic commands, config precedence#1555
Merged
garrytrinder merged 6 commits intomainfrom Feb 26, 2026
Merged
Improve CLI help text: I/O contract, dynamic commands, config precedence#1555garrytrinder merged 6 commits intomainfrom
garrytrinder merged 6 commits intomainfrom
Conversation
Co-authored-by: waldekmastykarz <11164679+waldekmastykarz@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve help text for I/O contract and commands
Improve CLI help text: I/O contract, dynamic commands, config precedence
Feb 25, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR improves Dev Proxy’s root CLI --help output so users (and agents) can understand configuration resolution, dynamic plugin commands, and stdout/stderr routing without reading source.
Changes:
- Adds a custom root-only help tail section (dynamic plugin commands note, output routing, config precedence) by wrapping
HelpActionwithDevProxyHelpAction. - Updates
--config-fileoption description to document default lookup behavior and~appFoldertoken support.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| DevProxy/Commands/DevProxyHelpAction.cs | Adds a HelpAction wrapper that appends extra root-only help sections. |
| DevProxy/Commands/DevProxyCommand.cs | Hooks help customization into root command setup and updates --config-file help text. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…mples, update --log-for to --output json
garrytrinder
approved these changes
Feb 26, 2026
Contributor
garrytrinder
left a comment
There was a problem hiding this comment.
Tested: builds clean. Root help now shows I/O contract, dynamic commands note, config precedence, exit codes. Config-file description updated. DevProxyHelpAction fixed to chain with HelpExamples (accepts SynchronousCommandLineAction). --log-for reference updated to --output json. Subcommand help correctly excludes root-only sections. LGTM.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
--helpoutput lacks information agents and users need to understand output routing, command variability, and config resolution. This is only discoverable by reading source code.Changes
--config-filedescription: Updated to document default lookup (devproxyrc.jsonin cwd) and~appFoldertoken supportDevProxyHelpActionwrappingHelpAction):CLI flags > config file > defaultsHasGlobalOptionsfilter onDevProxy.Plugins.*— no changes neededRoot
--helpnow ends with:Subcommand help is unaffected — the extra sections are gated on
parseResult.CommandResult.Command is RootCommand.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:
aka.ms/home/REDACTED/work/dev-proxy/dev-proxy/DevProxy/bin/Debug/net10.0/devproxy /home/REDACTED/work/dev-proxy/dev-proxy/DevProxy/bin/Debug/net10.0/devproxy --help(dns block)/home/REDACTED/work/dev-proxy/dev-proxy/DevProxy/bin/Debug/net10.0/devproxy /home/REDACTED/work/dev-proxy/dev-proxy/DevProxy/bin/Debug/net10.0/devproxy --version(dns block)/home/REDACTED/work/dev-proxy/dev-proxy/DevProxy/bin/Debug/net10.0/devproxy /home/REDACTED/work/dev-proxy/dev-proxy/DevProxy/bin/Debug/net10.0/devproxy cert --help(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.