arrow-left
All pages
gitbookPowered by GitBook
1 of 1

Loading...

Installation

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

hashtag
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

  • Latest LTS

  • Classic

  1. Get the Source Code

  • Open a terminal

  • Navigate to where you want Omnitool to be installed

  • Use the following command:

This will create the omnitool folder.

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

  1. Install Source Dependencies

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

  1. 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.

circle-info

See for the available parameters.

When successful, you will see the following message:

  1. Open Omnitool in a Web Browser

Omnitool.ai can now be accessed from:

circle-info

Explore the Code For a list of scripts we use internally, try running:


circle-info

Other Installation Methods:

  • A is under testing.

  • A is available.

If you're interested in cloud-based operation, reach out to us at contact@omnitool.aienvelope

Gitarrow-up-right
Node.jsarrow-up-right
Yarnarrow-up-right
Configuration
127.0.0.1:1688arrow-up-right
Docker Imagearrow-up-right
HuggingFace Spacearrow-up-right
  git clone https://github.com/omnitool-ai/omnitool
  cd omnitool
  yarn install
  yarn start
◐ Booting Server
✔ Server has started and is ready to accept connections on http://127.0.0.1:1688.
✔ Ctrl-C to quit.
yarn run