docs(help): document XDG config path in --help#53
Conversation
There was a problem hiding this comment.
Based on my review of the diff, I can see this is a simple documentation-only change:
Changes Summary:
pkg/cli/cli.goline 87: Added XDG config path documentation to the root command'sLongfieldintegration/cli_test.golines 88-90: Added integration test assertion to verify the config path appears in--helpoutputCHANGELOG.mdlines 11-13: Added## Unreleasedsection with the change descriptionprompts/completed/164-help-xdg-config-path.md: Completed dark-factory prompt (not code)
Review Assessment:
- The help text format is correct (
\n\nConfiguration:with proper paths) - The integration test correctly uses
ContainSubstringonsession.Out.Contents()(notgbytes.Say) to avoid streaming matcher issues - The CHANGELOG
## Unreleasedis correctly placed below the preamble, above version sections - Paths (
~/.config/vault-cli/config.yamland~/.vault-cli/config.yaml) are consistent between help text, test, and changelog - No behavioral changes, no security concerns, no architectural impacts
This is a pure docs change with appropriate test coverage.
{
"verdict": "approve",
"summary": "Pure documentation change that surfaces the XDG config path in vault-cli --help output. The help text, integration test, and CHANGELOG are all consistent and correctly formatted. No behavioral changes or code quality issues.",
"comments": [],
"concerns_addressed": [
"docs(help): XDG config path documentation added to root command help text",
"docs(help): integration test extended to verify config path appears in --help output",
"docs(changelog): Unreleased section added with correct bullet format"
]
}There was a problem hiding this comment.
Based on my review of the complete diff, here is the consolidated report:
PR Review: docs(help): document XDG config path in --help
Files changed: CHANGELOG.md, README.md, integration/cli_test.go, pkg/cli/cli.go, prompts/completed/164-help-xdg-config-path.md
Must Fix (Critical)
None.
Should Fix (Important)
None.
Nice to Have (Optional)
None.
Changes Reviewed
| File | Change | Assessment |
|---|---|---|
pkg/cli/cli.go:87 |
Extended Long field to document XDG config path in --help |
✅ Correct — exact paths used (~/.config/vault-cli/config.yaml / ~/.vault-cli/config.yaml), --config override mentioned |
README.md:37 |
Updated Configuration section to XDG-first with legacy fallback | ✅ Correct — clarifies primary path and fallback behavior |
integration/cli_test.go:88-90 |
Added ContainSubstring assertion for XDG path in --help output |
✅ Correct — avoids gbytes.Say() streaming issue by using session.Out.Contents() |
CHANGELOG.md:11-13 |
Added ## Unreleased section below preamble, above ## v0.99.1 |
✅ Correct — single bullet, conventional format |
Precommit Check
make precommit — skipped per selector mode. This is a docs-only change; CI covers lint+test.
Step 4 Status
Step 4 skipped: No rule-relevant files changed (no .go implementation logic, no .py, no k8s/, agents/, commands/, skills/, docs/ changes beyond CHANGELOG/README). The diff is entirely docstring/documentation/treatment of existing behavior — no architectural, security, or quality rules are triggered.
Verdict
{
"verdict": "approve",
"summary": "Documentation-only change that surfaces the already-active XDG config path behavior in --help output and README. The Long field extension uses exact paths, the integration test correctly avoids gbytes.Say() streaming issues, and CHANGELOG follows the preamble-relative format required by check-changelog.sh. No behavioral changes to any command, flag, or subcommand.",
"comments": [],
"concerns_addressed": []
}docs(help): document XDG config path in --help
Summary
Documents the config file location in
vault-cli --helpby extending the cobra root command'sLong:~/.config/vault-cli/config.yaml(XDG), falling back to~/.vault-cli/config.yaml(legacy)--configoverrides the defaultNo behavior change — resolution already works XDG-first; this only surfaces the path in help text.
Changes
Longwith a Configuration note--helpintegration test to assert the XDG path appears (order-independentContainSubstring)## UnreleasedbulletGoal
Part of vault goal Migrate Configs to XDG Base Directory (per-tool
--helpXDG-path SC).Test
make precommitgreen (run in dark-factory container + verified).