Skip to content

Commit 3f8297c

Browse files
Copilotwaldekmastykarzgarrytrinder
authored
Expand stdio command help text with examples, log behavior, and usage guidance (#1551)
* Initial plan * Expand stdio command help text with description, examples, and log/error behavior Co-authored-by: waldekmastykarz <11164679+waldekmastykarz@users.noreply.github.com> * Apply suggestion from @waldekmastykarz * Align example descriptions to the same column position Co-authored-by: waldekmastykarz <11164679+waldekmastykarz@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: waldekmastykarz <11164679+waldekmastykarz@users.noreply.github.com> Co-authored-by: Waldek Mastykarz <waldek@mastykarz.nl> Co-authored-by: Garry Trinder <garry@trinder365.co.uk>
1 parent 64f4277 commit 3f8297c

2 files changed

Lines changed: 26 additions & 2 deletions

File tree

DevProxy/Commands/DevProxyConfigOptions.cs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,19 @@ public DevProxyConfigOptions()
178178
return value;
179179
}
180180
};
181-
var stdioCommand = new Command("stdio", "Proxy stdin/stdout/stderr of local executables")
181+
var stdioCommand = new Command("stdio", """
182+
Proxy stdin/stdout/stderr of local executables.
183+
Dev Proxy intercepts and processes the stdio streams of the specified command,
184+
applying configured plugins (mocking, error simulation, etc.) to the traffic.
185+
Logs are written to a timestamped file (devproxy-stdio-YYYYMMDD-HHmmss.log)
186+
to avoid interfering with the proxied streams.
187+
Usage errors and exceptions are written to stderr.
188+
189+
Examples:
190+
devproxy stdio npx -y @devproxy/mcp Proxy MCP server
191+
devproxy stdio node server.js Proxy Node.js app
192+
devproxy stdio -c myconfig.json node app.js With custom config
193+
""")
182194
{
183195
stdioConfigFileOption,
184196
// Add a catch-all argument to consume remaining args (command to execute)

DevProxy/Commands/StdioCommand.cs

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,19 @@ public StdioCommand(
3232
ILogger<StdioCommand> logger,
3333
ILoggerFactory loggerFactory,
3434
IEnumerable<IStdioPlugin> plugins) :
35-
base("stdio", "Proxy stdin/stdout/stderr of local executables")
35+
base("stdio", """
36+
Proxy stdin/stdout/stderr of local executables.
37+
Dev Proxy intercepts and processes the stdio streams of the specified command,
38+
applying configured plugins (mocking, error simulation, etc.) to the traffic.
39+
Logs are written to a timestamped file (devproxy-stdio-YYYYMMDD-HHmmss.log)
40+
to avoid interfering with the proxied streams.
41+
Usage errors and exceptions are written to stderr.
42+
43+
Examples:
44+
devproxy stdio npx -y @devproxy/mcp Proxy MCP server
45+
devproxy stdio node server.js Proxy Node.js app
46+
devproxy stdio -c myconfig.json node app.js With custom config
47+
""")
3648
{
3749
_logger = logger;
3850
_loggerFactory = loggerFactory;

0 commit comments

Comments
 (0)