Docs out of sync with CLI/API surface (logs/status/stop options, jwtToken verb, summary option name)

[waldekmastykarz]

Summary

While verifying the documentation against the current code, I found several places where the docs describe options/verbs that do not match what the CLI and API actually expose. These are pre-existing doc/CLI drifts (unrelated to any engine work) — the documented flags either do not exist on those subcommands or have a different name/verb.

All findings below were confirmed directly against main.

Findings

1. logs command — documents options that do not exist

The docs list --log-level and --output for devproxy logs, but LogsCommand only defines:

• --follow / -f
• --lines / -n
• --since
• --pid

--log-level and --output exist only on the root devproxy command, not on the logs subcommand.

2. status command — documents options that do not exist

The docs list --log-level / --output for devproxy status, but StatusCommand only defines:

• --pid

3. stop command — documents options that do not exist

The docs list --log-level / --output for devproxy stop, but StopCommand only defines:

• --force / -f
• --pid

4. API reference — jwtToken documented as GET, actually POST

The API reference (the GET /proxy/jwtToken section) lists:

GET /proxy/jwtToken

but the endpoint is a POST:

• ProxyController.cs → [HttpPost("jwtToken")]
• The in-product devproxy api listing already correctly reports it as POST /proxy/jwtToken … Create a JWT token.

So the standalone API reference page is the only place that is wrong.

5. Troubleshooting example references a non-existent option

The "why is the proxy saying that an option is unknown" page uses --summary-file-path as the example. ExecutionSummaryPlugin only exposes:

• --summary-group-by

There is no --summary-file-path option, so the example itself would trigger the very "unknown option" error it is documenting. A real, current option should be used instead.

Suggested fix

Update the affected doc pages so the documented options/verbs match the code:

• logs / status / stop command pages → list only the options each subcommand actually defines (see above).
• API reference → change jwtToken from GET to POST.
• Troubleshooting page → replace the --summary-file-path example with a currently valid option.

Notes

Confirmed against code on main:

• DevProxy/Commands/LogsCommand.cs, StatusCommand.cs, StopCommand.cs
• DevProxy/ApiControllers/ProxyController.cs ([HttpPost("jwtToken")])
• DevProxy/Commands/ApiCommand.cs (already lists POST /proxy/jwtToken)
• DevProxy.Plugins/Reporting/ExecutionSummaryPlugin.cs (--summary-group-by)