- Documentation (2.5.0-rc1)
- Release Notes
- Tutorials
- Reference
- Introduction
- Settings Files
- Ivy Files
- Ant Tasks
- artifactproperty
- artifactreport
- buildlist
- buildnumber
- buildobr
- cachefileset
- cachepath
- checkdepsupdate
- cleancache
- configure
- convertmanifest
- convertpom
- deliver
- dependencytree
- findrevision
- fixdeps
- info
- install
- listmodules
- makepom
- post resolve tasks
- publish
- report
- repreport
- resolve
- resources
- retrieve
- settings
- var
- Using standalone
- OSGi
- Developer doc
install
[since 1.3]
Installs a module and all its dependencies in a resolver.
The module to install should be available in a resolver, and will be installed in another resolver which should support publish.
This is particularly useful for users who only have a private repository, and want to benefit from public repositories from time to time. In this case, when a module is missing in the private repository, a call to install lets download the module from a public repository not usually used for dependency resolution, and install it and its dependencies in the private repository.
For more details about this task and its usage see the build repository tutorial
Attributes
Attribute | Description | Required |
---|---|---|
from |
the name of the resolver in which the module must be found |
Yes |
to |
the name of the resolver in which the module must be installed |
Yes |
organisation |
the name of the organisation of the module to install |
Yes |
module |
the name of the module to install |
Yes |
branch |
the branch of the module to install (since 2.0) |
No, defaults to default branch with exact matcher, |
revision |
the revision of the module to install |
Yes |
type |
the type(s) of artifact(s) to install. You can give multiple values separated by commas |
No, defaults to |
conf |
the configurations to install. Only the dependencies of the specified configurations will be installed. (since 2.3) |
No, defaults to |
validate |
|
No. Defaults to default Ivy value (as configured in settings) |
overwrite |
|
No, defaults to |
transitive |
|
No, defaults to |
matcher |
the name of the matcher to use to find the modules to install |
No, defaults to |
settingsRef |
A reference to Ivy settings that must be used by this task (since 2.0) |
No, defaults to |
haltonfailure |
|
No, defaults to |
installOriginalMetadata |
|
No, defaults to |
Examples
<ivy:install organisation="apache" module="commons-lang" revision="2.0" from="ivyrep" to="myfsresolver"/>
Installs the module commons-lang
from apache
in revision 2.0 in the resolver myfsresolver
. The module is found in the resolver named ivyrep
.