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.
Prerequisites
Ensure you have the latest versions of the following software installed:
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
Install Source Dependencies
Run the following command in the root of the repository to install the necessary dependencies:
yarn install
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
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.
Open Omnitool in a Web Browser
Omnitool.ai can now be accessed from: 127.0.0.1:1688
Last updated
Was this helpful?