Skip to content

Docs should explain how ASDF_${TOOL}_VERSION env vars work for tools containing dashes #2299

Description

@sh-at-cs

How can we improve the documentation?

The current docs on specifying versions via env var use ASDF_ELIXIR_VERSION as an example, but don't mention what the variables should look like for tools whose names contain dashes, e.g. aws-sam-cli: Should it be ASDF_AWS_SAM_CLI_VERSION or ASDF_AWSSAMCLI_VERSION?

An LLM found the relevant code which answers my question:

sanitized := strings.ReplaceAll(upper, "-", "_")

So it is in fact ASDF_AWS_SAM_CLI_VERSION. But I shouldn't have to ask an LLM, the docs should just mention how it works for hyphenated/dashed tool names.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions