1. Maven Plugin:

This method is ideal for projects with Maven-based builds. It simplifies integration by allowing you to run Anteater directly within multi-module projects where sub-projects are managed as Maven modules. This approach ensures seamless execution and minimal configuration within the Maven ecosystem.

You can run Anteater directly from the root folder of your parent project using Maven. This approach does not require a pom.xml file in the parent directory, making it quick and easy to execute.

Command:

mvn com.ganteater:ae-maven-plugin:run

This command executes Anteater in the parent project, allowing you to manage and automate workflows across sub-projects efficiently.

For more information about the Maven plugin, you can visit: Maven Plugin

2. Standalone Application:

If your project is not Maven-based or you prefer to run Anteater independently of your build system, the standalone application is a better fit. This method provides greater flexibility for custom workflows and allows you to configure Anteater in a way that suits your specific environment.

By offering these two approaches, Anteater ensures that you can manage your multi-module projects efficiently, regardless of your build system or workflow preferences.

If you prefer to use Anteater as a standalone application, you’ll need to set it up in your home directory ($USER_HOME/anteater) and configure your environment accordingly.

Steps to Set Up Anteater:

1. Download Anteater Application (see.: “Short Cut”):
   Obtain the Anteater application and place it in the %HOMEPATH%/anteater directory (Windows) or $HOME/anteater directory (Linux/Mac).

2. Download Required Plugins:
   Download all necessary plugins for your project and place them in the plugins folder within the %HOMEPATH%/anteater directory.

3. Create a Batch File (Windows):
   Create a .bat file in the Anteater directory to simplify execution.
   Example batch file content:

   @echo off
   rem Set the classpath to include the Anteater JAR and all plugins
   java -cp "%~dp0/anteater.jar;%~dp0/plugins/*.jar" com.ganteater.ae.desktop.Anteater
   

If sub-modules in your parent project contain Anteater Maven projects, you must specify the Maven home parameter: -Dmaven.home=<maven/home/path>. This ensures that the correct Maven installation is used during execution.

1. Update PATH Environment Variable (Windows):

   • Add the Anteater directory to your PATH environment variable to allow Anteater to be run from anywhere in the terminal.

   • Steps:

     • Go to System Properties → Environment Variables.
     • Add %USER_HOME%\anteater to the PATH.

2. For Other Operating Systems:
   Perform similar actions to set up Anteater:

   • Place the application in $USER_HOME/anteater.
   • Create an executable script (e.g., .sh file) for launching Anteater.
   • Add the Anteater directory to your PATH environment variable.