# `mix hex.config`
[🔗](https://github.com/hexpm/hex/blob/v2.5.1/lib/mix/tasks/hex.config.ex#L1)

Reads, updates or deletes local Hex config.

## List config keys and values

    $ mix hex.config

## Get or delete config value for KEY

    $ mix hex.config KEY [--delete]

## Set config KEY to VALUE

    $ mix hex.config KEY VALUE

## Config keys

  * `api_key` - Your API key. If you are authenticated this config will override
    the API key used for your authenticated user. Can be also be overridden by
    setting the environment variable `HEX_API_KEY`
  * `api_url` - Hex API URL. Can be overridden by setting the environment
    variable `HEX_API_URL` (Default: `"https://hex.pm/api"`)
  * `offline` - If set to true Hex will not fetch the registry or packages and
    will instead use locally cached files if they are available. Can be
    overridden by setting the environment variable `HEX_OFFLINE` (Default:
    `false`)
  * `unsafe_https` - If set to true Hex will not verify HTTPS certificates.
    Can be overridden by setting the environment variable `HEX_UNSAFE_HTTPS`
    (Default: `false`)
  * `unsafe_registry` - If set to true Hex will not verify the registry
    signature against the repository's public key. Can be overridden by
    setting the environment variable `HEX_UNSAFE_REGISTRY` (Default:
    `false`)
  * `no_verify_repo_origin` - If set to true Hex will not verify the registry
    origin. Can be overridden by setting the environment variable
    `HEX_NO_VERIFY_REPO_ORIGIN` (Default: `false`)
  * `http_proxy` - HTTP proxy server. Can be overridden by setting the
    environment variable `HTTP_PROXY`
  * `https_proxy` - HTTPS proxy server. Can be overridden by setting the
    environment variable `HTTPS_PROXY`
  * `no_proxy` - A comma separated list of hostnames that will not be proxied,
    asterisks can be used as wildcards. Can be overridden by setting the
    environment variable `no_proxy` or `NO_PROXY`
  * `http_concurrency` - Limits the number of concurrent HTTP requests in
    flight. Can be overridden by setting the environment variable
    `HEX_HTTP_CONCURRENCY` (Default: `8`)
  * `http_timeout` - Sets the timeout for HTTP requests in seconds. Can be
    overridden by setting the environment variable `HEX_HTTP_TIMEOUT`
  * `mirror_url` - Hex mirror URL. Can be overridden by setting the
    environment variable `HEX_TRUSTED_MIRROR_URL`
  * `trusted_mirror_url` - Hex mirror URL. Unlike `mirror_url`, this mirror is
    "trusted", secrets such as authentication information will be sent to the
    mirror. Can be overridden by setting the environment variable
    `HEX_TRUSTED_MIRROR_URL`
  * `cacerts_path` - Path to the CA certificate store PEM file. If not set,
    a CA bundle that ships with Hex is used. Can be overridden by setting the
    environment variable `HEX_CACERTS_PATH`
  * `no_short_urls` - If set to true Hex will not
    shorten any links. Can be overridden by setting the environment variable
    `HEX_NO_SHORT_URLS` (Default: `false`)
  * `cooldown` - Minimum age a package release must have to be considered
    during dependency resolution, e.g. `"7d"`, `"2w"`, `"1mo"`. Releases
    published more recently are filtered out of the candidate set when
    resolving dependencies. Does not apply to installs from an existing
    lockfile. Can be overridden by setting the environment variable
    `HEX_COOLDOWN` (Default: `"0d"` — no cooldown). See
    https://hex.pm/docs/dependency-policies for the full guide.
  * `cooldown_exclude_repos` - List of repository names for which
    `cooldown` does not apply, e.g. `["hexpm:myorg"]`. Useful when an
    organization publishes hotfixes to its own repository and wants to
    consume them without cooldown delay. Can be overridden by setting
    the environment variable `HEX_COOLDOWN_EXCLUDE_REPOS` to a
    comma-separated list (Default: `[]`). See
    https://hex.pm/docs/dependency-policies for the full guide.
  * `ignore_advisories` - List of security advisory IDs to acknowledge,
    e.g. `["CVE-2026-32686"]`. Matching advisories are not reported by
    `mix hex.audit`, `mix deps.get`, and `mix deps.update`. An ID matches
    an advisory's primary ID or any of its aliases. Can be overridden by
    setting `HEX_IGNORE_ADVISORIES` as a comma-separated list.
    (Default: `[]`)
  * `ignore_retirements` - List of packages whose retirement to
    acknowledge, as atoms with an optional pinned version, e.g.
    `[:decimal, phoenix: "1.0.0"]`. Matching retirements are not reported
    by `mix hex.audit`, `mix deps.get`, and `mix deps.update`. Can be
    overridden by setting `HEX_IGNORE_RETIREMENTS` as a comma-separated
    list of `NAME` or `NAME@VERSION` entries. (Default: `[]`)
  * `policy` - The policy this Hex client honors at resolution time, as a
    `REPO/NAME` pair, e.g. `hexpm:myorg/strict-prod`. The `mix.exs` `:hex`
    block also accepts `policy: [org: "ORG", name: "NAME"]` for a hexpm
    organization, or `policy: [repo: "REPO", name: "NAME"]` for any other
    configured repository. Can be overridden by setting the environment
    variable `HEX_POLICY`, where an empty value disables the configured
    policy. See https://hex.pm/docs/dependency-policies for the full guide.

Hex responds to these additional environment variables:

  * `HEX_HOME` - directory where Hex stores the cache and configuration
    (Default: `~/.hex`)

  * `MIX_XDG` - asks Hex to follow the [XDG Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html)
    for its home directory and configuration files. `HEX_HOME` has higher preference
    than `MIX_XDG`. If none of the variables are set, the default directory
    `~/.hex` will be used.

## Config overrides

All keys from the "Config keys" section above can be overridden.

Hex uses the following order of precedence when computing a value for a given key:

  1. System environment

     Setting for example `HEX_API_URL` environment variable has always the
     highest precedence for the `api_url` config key.

  2. Project configuration

     Hex allows an optional, per-project configuration in the `mix.exs` file.

     For example, to override `api_url` config key, add the following:

         # mix.exs
         defmodule MyApp.MixProject
           def project() do
             [
               # ...
               deps: deps(),
               hex: hex()
             ]
           end

           defp hex() do
             [
               api_url: "https://hex.myorg/api"
             ]
           end
         end

  3. Global configuration using `mix hex.config KEY VALUE`

  4. Default value

## Command line options

  * `--delete` - Remove a specific config key

---

*Consult [api-reference.md](api-reference.md) for complete listing*