# Installing agy

`agy` is intended to be installed as a Mix archive so `mix agy` is available
globally, similar to archive tasks such as `mix hex.new`.

## Install From Hex

```sh
mix archive.install hex agy
```

After installation, enter any Elixir project directory and run:

```sh
mix agy --readme
mix agy --mode plan path/to/implementation_plan.md --dry-run
```

The target project does not need to declare `{:agy, ...}` in its `mix.exs`.

## Install From Source

From this repository:

```sh
MIX_ENV=prod mix do archive.build --force, archive.install --force
```

`MIX_ENV=prod` builds the runtime archive without requiring dev-only
documentation dependencies such as `ex_doc`.

## Notes

Third-party Mix tasks cannot be globally available with no prior installation.
The intended model is one-time archive installation, then global use from any
project directory.