# `Cldr.Install`
[🔗](https://github.com/elixir-cldr/cldr/blob/v2.47.4/lib/cldr/install.ex#L1)

Provides functions for installing locales.

When installed as a package on from [hex](http://hex.pm), `Cldr` has only
the default locales `["en", "und"]` installed and configured.

When other locales are added to the configuration `Cldr` will attempt to
download the locale from [github](https://github.com/elixir-cldr/cldr)
during compilation.

If `Cldr` is installed from github directly then all locales are already
installed.

# `client_data_dir`

# `client_locale_file`

Returns the full pathname of the locale's json file.

* `locale` is any locale returned by `Cldr.known_locale_names/1`

No checking of locale validity is performed.

# `client_locales_dir`

# `install_all_locale_names`

Install all available locales.

# `install_known_locale_names`

Install all the configured locales.

# `install_locale_name`

Download the requested locale from github into the
client application's cldr data directory.

* `locale` is any locale returned by `Cldr.known_locale_names/1`

* `options` is a keyword list.  Currently the only supported
  option is `:force` which defaults to `false`.  If `truthy` the
  locale will be installed or re-installed.

The data directory is typically `priv/cldr/locales`.

This function is intended to be invoked during application
compilation when a valid locale is configured but is not yet
installed in the application.

An https request to the master github repository for `Cldr` is made
to download the correct version of the locale file which is then
written to the configured data directory.

# `locale_filename`

# `locale_installed?`

Returns a `boolean` indicating if the requested locale is installed.

No checking of the validity of the `locale` itself is performed.  The
check is based upon whether there is a locale file installed in the
client application or in `Cldr` itself.

# `locale_stale?`

Returns a `boolean` indicating if the requested locale has available
data but the data is stale (is a older version not supported by this
version of `ex_cldr`.)

---

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