# `mix patina.install`
[🔗](https://github.com/patinalang/mix_patina/blob/main/lib/mix/tasks/patina.install.ex#L1)

Installs Patina into `~/.patina` (`%USERPROFILE%\.patina` on Windows).

It defaults to downloading the nightly build for this machine from Patina's
GitHub releases, and checks it against its SHA-256 checksum. A path or URL
of a release tarball can be given as an argument instead:

    $ mix patina.install path/to/patina-nightly-aarch64-apple-darwin.tar.gz

Patina build tools automatically look for `patina` executable within
`~/.patina`, as a default fallback, so it does not have to be added to `PATH`.

## Command line options

  * `PATH|URL` - specifies a path or URL to a release tarball.
    Disables automatic `sha256` verification; pass explicit `--sha256` for checks.

  * `--version VSN` - installs the given release instead of `nightly`.
    Can't be combined with `PATH|URL`.

  * `--sha256 SHA|PATH|URL` - checks the tarball matches the given SHA-256 checksum.
    Takes the checksum itself, or a path or URL of a `sha256sum`-style checksum file.

  * `--no-check` - skips fetching and checking the published SHA-256 checksum.
    Can't be combined with `--sha256`.

  * `--force` - replaces an existing install without a shell prompt.

  * `--if-missing` - installs only if Patina isn't installed yet.

  * `--install-path PATH` - installs into the given directory instead of `~/.patina`.

## Mirrors

Set the `PATINA_RELEASES_URL` env variable to fetch the builds from a custom
mirror. The tarball is fetched from
`$PATINA_RELEASES_URL/VERSION/patina-VERSION-TARGET.tar.gz`.
A separate `PATINA_RELEASES_SHA256_URL` governs the download of `.sha256` files
used to verify archive integrity. The checksum file is fetched from
`$PATINA_RELEASES_SHA256_URL/VERSION/patina-VERSION-TARGET.tar.gz.sha256`.

Both environment variables default to `https://github.com/patinalang/patina/releases/download`.

---

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