# Installation

We are currently testing installers for Windows and macOS. Until those are publicly available, please follow the manual installation steps.

## Manual Install

This guide will help you download the Omnitool software, and then build and start the Omnitool server in a directory running from your local machine.

You can then access the Omnitool software from a web browser on your local machine.

1. **Prerequisites**

Ensure you have the latest versions of the following software installed:

* Latest [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* Latest LTS [Node.js](https://nodejs.org/en)
* Classic [Yarn](https://classic.yarnpkg.com/en/docs/install)

2. **Get the Source Code**

* Open a terminal
* Navigate to where you want Omnitool to be installed
* Use the following command:

```
  git clone https://github.com/omnitool-ai/omnitool
```

This will create the `omnitool` folder.

* Now navigate inside Omnitool's folder. By default:

```
  cd omnitool
```

3. **Install Source Dependencies**

Run the following command in the root of the repository to install the necessary dependencies:

```
  yarn install
```

4. **Build and Start the Server**

Now we will use `yarn` and `Node.js` to build the server software locally on your machine and then start it running. 

```
  yarn start
```

{% hint style="info" %}
See [configuration](https://omnitool-ai.gitbook.io/omnitool/getting-started/configuration "mention") for the available parameters.
{% endhint %}

When successful, you will see the following message:

```
◐ Booting Server
✔ Server has started and is ready to accept connections on http://127.0.0.1:1688.
✔ Ctrl-C to quit.
```

5. **Open Omnitool in a Web Browser**

Omnitool.ai can now be accessed from: [127.0.0.1:1688](http://127.0.0.1:1688/)

{% hint style="info" %}
**Explore the Code** For a list of scripts we use internally, try running:

```
yarn run
```

{% endhint %}

***

{% hint style="info" %}
**Other Installation Methods:**

* A [Docker Image](https://hub.docker.com/r/manusapiens/omnitool-test6) is under testing.
* A [HuggingFace Space](https://huggingface.co/omnitool-ai) is available.
* If you're interested in cloud-based operation, reach out to us at <contact@omnitool.ai>
  {% endhint %}