Creating an account and downloading

Create your account at search2o.com/gettingstarted, which shows your license key, then install the agent server with pip.

Create your account

Search2o is in open beta, and anyone is welcome to try it. Creating an account is one step. It opens a free account with you as its first user and owner, and shows the account's license key once. The key connects an agent server to your account in Search2o Cloud, so store it with your other secrets as soon as it is shown. You are not asked for a password; you choose one the first time you open the UI.

Install

The agent server, with the bundled UI, requires Python 3.12 or later and is published on PyPI as search2o:

$ pip install search2o

The db command uses SQLAlchemy's async engines, so the driver for your database must be installed too. SQLite works without an extra driver. The other drivers are optional extras of the package:

$ pip install "search2o[postgres]"   # asyncpg
$ pip install "search2o[mysql]"      # aiomysql, also used for MariaDB
$ pip install "search2o[oracle]"     # oracledb
$ pip install "search2o[mssql]"      # aioodbc, also needs a system ODBC driver
$ pip install "search2o[db]"         # postgres, mysql and oracle together

A note on mssql: aioodbc presents an async API but wraps the synchronous ODBC driver underneath. The agent server is fully asynchronous, so a driver that blocks under load can slow the whole server.

To install from the source

Clone the agent server and install it from the clone. The clone does not include the UI.

$ git clone https://github.com/Search2o/agent-server.git
$ pip install -e agent-server

Then build the UI, which needs Node.js 22.18 or newer, and copy the build into the agent server's ui directory:

$ git clone https://github.com/Search2o/ui.git
$ cd ui && npm install && npm run build
$ cp -R dist ../agent-server/search2o/ui

On Windows, copy the dist folder to the same directory. Any web server can serve the UI instead; see How the UI runs. For the license, see License.