docs: show -- when passing Caddy flags through xcaddy - #281
Open
locker95 wants to merge 1 commit into
Open
Conversation
xcaddy uses cobra for its own flags, so `xcaddy run --config ...` fails with "unknown flag: --config". Pass Caddy args after `--`, e.g. `xcaddy -- run --config caddy.json`. Fixes caddyserver#231 Signed-off-by: Dean Chen <862469039@qq.com>
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
1 participant
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.
Summary
xcaddy run --config caddy.jsonfails withunknown flag: --configbecause cobra parses flags before pass-through. The working form isxcaddy -- run --config caddy.json.This updates the plugin-development examples in the README and mentions the same in the root command long help so the documented usage matches what cobra actually accepts.
Docs-only (plus a one-line help-text note). No CLI behavior change.
Test plan
xcaddy -- run --config caddy.json--separatorxcaddy -- run --config caddy.jsonruns; barexcaddy run --config caddy.jsonstill errors as beforeFixes #231