> For the complete documentation index, see [llms.txt](https://omnitool-ai.gitbook.io/omnitool/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://omnitool-ai.gitbook.io/omnitool/getting-started/installation.md).

# 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](/omnitool/getting-started/configuration.md) 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 %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://omnitool-ai.gitbook.io/omnitool/getting-started/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.