Welcome to Ivy reference documentation.

If you don't know Ivy at all, give a glance at its features, the FAQ and the tutorials before digging into this reference documentation.

Reference Overview

This documentation is decomposed in several parts:

• Terminology

This part gives you the meaning of some words used all over ivy doc, such as organisation, module, configurations, ...

• Main Concepts

This part introduces the main concepts used in Ivy: dependency resolvers, variables, patterns, and also a good introduction to a central ivy concept: module configurations.

• How does it work ?

As the title suggest, here you will have some explanations on how does ivy work internally, which can help to better understand and customize its use.

• Installation

This part describe how to install Ivy

• Configuration

This part is dedicated to the specification of the configuration file of Ivy (usually called ivyconf.xml). It also gives the list of built-in dependency resolvers available in ivy.

• Ivy files

This part is the reference of the specification of the ivy files, the files in which you describe your dependencies. If you have any question of what can be done or not in an ivy file, you will have the answer here.

• Use

This part describes how to use ivy: it briefly explains how to call ivy from command line, and deeply explains how to use it from ant, which is the main way to use ivy. It's in this section that all ant tasks brought by ivy are specified.

• Extend

This part describes how to extend ivy, by writing your own dependency resolver, latest strategy, etc.