Current section

Files

Jump to
igniter_new priv docs igniter.install long.txt
Raw

priv/docs/igniter.install/long.txt

Install a package or packages, running any Igniter installers.
## Args
mix igniter.install package1 package2 package3
## Package formats
* `package` - The latest version of the package will be installed, pinned
at the major version, or minor version if there is no major version yet.
* `package@version` - The package will be installed at the specified
version. If the version given is generic, like `3.0`, it will be pinned as
described above. if it is specific, like `3.0.1`, it will be pinned at that
*exact* version with `==`.
* `package@git:git_url` - The package will be installed from the
specified git url.
* `package@github:project/repo` - The package will be installed from the
specified github repo.
* `package@github:project/repo@ref` - The package will be installed from
the specified github repo, at the specified ref (i.e tag, branch, commit).
* `package@path:path/to/dep` - The package will be installed from the
specified path.
* `org/package` - The package exists in a private Hex organization. This
can be used along with all the options above, e.g. `org/package@version`.
Additionally, a Git ref can be specified when using `git` or `github`:
* `package@git:git_url@ref`
## Options
* `--only` - Install the requested packages in only a specific
environment(s), i.e `--only dev`, `--only dev,test`
## Switches
* `--dry-run` - Run the task without making any changes.
* `--yes` - Automatically answer yes to any prompts.
* `--yes-to-deps` - Automatically answer yes to any prompts about
installing new deps.
* `--verbose` - Display additional output from various operations.
* `--example` - Request that installed packages include initial example
code.
`argv` values are also passed to the igniter installer tasks of installed
packages.