> ## Documentation Index
> Fetch the complete documentation index at: https://docs.loqate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Local API install process

The following sections demonstrate the steps of the installation process for Local API installation.

## Installation Using GUI

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image110.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=51e3ccc3b57d9e83fd004cc9d9c05176" width="379" height="295" data-path="images/Image110.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image28.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=f7ab7d4ca4f11471e35c6394c7880147" width="379" height="295" data-path="images/Image28.png" />
</Frame>

After seeing the welcome screen and accepting the license agreement, the next screen shows the components to install. For Install Manager to work, the Loqate Java API is required.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image31.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=311facf5a20609cbe19e71e9f031f655" width="379" height="295" data-path="images/Image31.png" />
</Frame>

The next step is to select a folder to install the Local API. If Install Manager was selected as a component to install, then a local copy of Java Run time Environment will be installed in addition to `InstallManager.jar` and a script or a batch file (`InstallManager.bat` for Windows and `InstallManager.sh` for Linux/Unix platforms) for running Install Manager. The Java Runtime Environment will be installed locally so there will be no effect on the system settings in the target machine.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image41.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=4906abe2864d98ea4c432eb5b2b28e6f" width="379" height="295" data-path="images/Image41.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image51.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=4b8f7f6a11dd9aa62260e788194d1d50" width="379" height="295" data-path="images/Image51.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image61.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=056aeb74ec363f9753135995330ce961" width="379" height="295" data-path="images/Image61.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image71.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=2906edcfab0e5bf4e97dd8fb76c59825" width="379" height="295" data-path="images/Image71.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image81.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=7c503230d4343464e69564f38faa4e5b" width="379" height="295" data-path="images/Image81.png" />
</Frame>

## Installation Using the Command Line Interface

On Linux/Unix platforms, the preferred method of installation is using the command line interface.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image91.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=86a758731d436f3e280b6950ae350335" width="509" height="320" data-path="images/Image91.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image101.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=e88314c4f689eeba2a08fba4fb795ca7" width="509" height="320" data-path="images/Image101.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image111.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=3cb8c72978e9ab591d727a959b227f48" width="506" height="307" data-path="images/Image111.png" />
</Frame>

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image121.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=353b2c8d08b9318ebfff906fc5b9b7fa" width="509" height="320" data-path="images/Image121.png" />
</Frame>

When selecting components, if Install Manager is selected, then the Java API is also installed.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image131.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=f89ae7fa0e6bdcb5cad6c53eae9d2994" width="509" height="320" data-path="images/Image131.png" />
</Frame>

If Install Manager is selected as a component to install, the installer will install a local copy of the Java Runtime Environment (JRE) as well. This is needed to run Install Manager. This local copy of JRE will not affect any system settings on the target machine.

<Frame caption="">
  <img src="https://mintcdn.com/loqate/7owb0a8870OAPvwG/images/Image141.png?fit=max&auto=format&n=7owb0a8870OAPvwG&q=85&s=229db93cfe11b7ac98d4ac07f5430935" width="509" height="320" data-path="images/Image141.png" />
</Frame>