API Reference Hex v0.21.1

Mix Tasks

Prints Hex tasks and their information.

Shows all Hex dependencies that have been marked as retired.

Builds a new local version of your package.

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 (Default: nil)
  • https_proxy - HTTPS proxy server. Can be overridden by setting the environment variable HTTPS_PROXY (Default: nil)
  • 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 (Default: nil)
  • 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 (Default: nil)
  • mirror_url - Hex mirror URL. Can be overridden by setting the environment variable HEX_MIRROR (Default: nil)
  • 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. (Default: nil)

Hex responds to these additional environment variables

Fetches or opens documentation of a package.

Prints Hex package or system information.

Manages the list of authorized Hex.pm organizations.

Shows all Hex dependencies that have newer versions in the registry.

Adds, removes or lists package owners.

Fetches or diffs packages.

Publishes a new version of the package.

Manages local Hex registries.

Manages the list of available Hex repositories.

Retires a package version.

Displays packages matching the given search query.

Show Hex packages in your dependencies that accept sponsorships.

Hex user tasks.