Skip to content

feat(config): add --describe flag to pixi config list - #7160

Open
ZachFlint wants to merge 1 commit into
prefix-dev:mainfrom
ZachFlint:config-describe
Open

ZachFlint wants to merge 1 commit into
prefix-dev:mainfrom
ZachFlint:config-describe

Conversation

@ZachFlint

Copy link
Copy Markdown
Contributor

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 --json emits a structured array suitable for tooling.

Closes #1457.

How Has This Been Tested?

  • Added unit tests in pixi_config cross-checking describe_keys() against get_keys() for completeness.
  • Added an integration test in tests/integration_python/test_main_cli.py covering: unfiltered describe, key-filtered describe, set-value
    rendering, per-bucket keys like s3-options.my-bucket.region, JSON output shape, and unknown-key error.

AI Disclosure

  • This PR contains AI-generated content.
    • I have tested any AI-generated content in my PR.
    • I take responsibility for any AI-generated content in my PR.

Tools: Claude

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added sufficient tests to cover my changes.

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 lucascolley added enhancement New features cli configuration Configuration of workspace or global behavior labels Oct 5, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli configuration Configuration of workspace or global behavior enhancement New features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(config): option to exhaustively list all configuration options (like conda config --describe)

2 participants