Repository navigation
Conversation
Adds an annotated TOML-style listing of every available configuration option with its type, default, and a short explanation. Keys that are currently set print uncommented with their value; the rest are emitted as commented stubs showing the default. `--describe [KEY]` describes one key, including per-bucket keys such as `s3-options.my-bucket.region`. `--describe --json` emits a structured array suitable for tooling. The option is also documented in the configuration reference. Closes prefix-dev#1457.
lucascolley
added
enhancement
prefix-dev#7221 rejects relative `detached-environments` paths, so say so in the `--describe` output.
Return a `DescribeError` instead of adding `into_diagnostic` calls, as the ratchet from prefix-dev#7204 asks (see prefix-dev#6707), and print `--describe` output through the same path as the rest of `config list`.
Contributor
Author
|
hey @lucascolley, saw your #7221 go in so I updated the detached-environments description here to match, and switched the describe code over to a typed error for the into_diagnostic check. since you've been in the config code lately would you be up for reviewing this one? no rush |
lucascolley
self-requested a review
October 16, 2026 21:57
This branch has not been deployed
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
2 participants
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.
Continues #6189, which was closed when I accidentally deleted my fork.
Description
Adds an annotated TOML-style listing of every available configuration option with its type, default, and a short explanation. Keys that are currently set print uncommented with their value; the rest are emitted as commented stubs showing the default.
--describe [KEY]describes one key.--describe --jsonemits a structured array suitable for tooling.Closes #1457.
How Has This Been Tested?
rendering, per-bucket keys like
s3-options.my-bucket.region, JSON output shape, and unknown-key error.AI Disclosure
Tools: Claude
Checklist: