diff --git a/DevProxy/Commands/DevProxyConfigOptions.cs b/DevProxy/Commands/DevProxyConfigOptions.cs index da68c6d4..c8d323bb 100644 --- a/DevProxy/Commands/DevProxyConfigOptions.cs +++ b/DevProxy/Commands/DevProxyConfigOptions.cs @@ -178,7 +178,19 @@ public DevProxyConfigOptions() return value; } }; - var stdioCommand = new Command("stdio", "Proxy stdin/stdout/stderr of local executables") + var stdioCommand = new Command("stdio", """ + Proxy stdin/stdout/stderr of local executables. + Dev Proxy intercepts and processes the stdio streams of the specified command, + applying configured plugins (mocking, error simulation, etc.) to the traffic. + Logs are written to a timestamped file (devproxy-stdio-YYYYMMDD-HHmmss.log) + to avoid interfering with the proxied streams. + Usage errors and exceptions are written to stderr. + + Examples: + devproxy stdio npx -y @devproxy/mcp Proxy MCP server + devproxy stdio node server.js Proxy Node.js app + devproxy stdio -c myconfig.json node app.js With custom config + """) { stdioConfigFileOption, // Add a catch-all argument to consume remaining args (command to execute) diff --git a/DevProxy/Commands/StdioCommand.cs b/DevProxy/Commands/StdioCommand.cs index b3c7db17..9b5b6867 100644 --- a/DevProxy/Commands/StdioCommand.cs +++ b/DevProxy/Commands/StdioCommand.cs @@ -32,7 +32,19 @@ public StdioCommand( ILogger logger, ILoggerFactory loggerFactory, IEnumerable plugins) : - base("stdio", "Proxy stdin/stdout/stderr of local executables") + base("stdio", """ + Proxy stdin/stdout/stderr of local executables. + Dev Proxy intercepts and processes the stdio streams of the specified command, + applying configured plugins (mocking, error simulation, etc.) to the traffic. + Logs are written to a timestamped file (devproxy-stdio-YYYYMMDD-HHmmss.log) + to avoid interfering with the proxied streams. + Usage errors and exceptions are written to stderr. + + Examples: + devproxy stdio npx -y @devproxy/mcp Proxy MCP server + devproxy stdio node server.js Proxy Node.js app + devproxy stdio -c myconfig.json node app.js With custom config + """) { _logger = logger; _loggerFactory = loggerFactory;