Self-host

Install SynapseOrch on your own machine

Free and open source under AGPL-3.0, with no account and no licence check. One line installs it, asks which AI to use, and opens it in your browser.

Install

One line for your system

  • macOS

    in Terminal

    Terminal
    curl -LsSf https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.sh | bash
  • Linux

    in a terminal

    bash
    curl -LsSf https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.sh | bash
  • Windows

    in PowerShell

    PowerShell
    irm https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.ps1 | iex
  • Docker

    on any system with Docker

    docker
    docker run -d --name synapse -p 3000:3000 -p 127.0.0.1:8765:8765 -v synapse-data:/data -v /var/run/docker.sock:/var/run/docker.sock synapseorchai/synapse-ai:latest

    Then open the link that docker logs synapse prints. The Docker socket is for Python tools, which run in sandbox containers.

The one-line installer needs nothing installed first: it brings Python, Node.js and a browser for your agents when they are missing. It asks for your AI provider, its key and a model, and whether to start SynapseOrch when you log in, then ends with the link. Everything it keeps is in ~/.synapse.

Already installed

Upgrades, and Knowledge's PDF reader

Upgrade

Stops SynapseOrch, backs up its database, installs the newest release with every part you added, and starts it again if it was running.

bash
synapse upgrade

On 1.x, run the install line above, or 1.x’s own synapse upgrade. Your agents, workflows, chats and settings come across. Upgrading from 1.x

Read PDFs with their layout

Knowledge reads every file it supports on its own. This adds Docling’s layout and table reader for PDFs and fetches its models once, with PyTorch’s CPU build: no GPU libraries. It stays through every upgrade.

bash
synapse upgrade --with knowledge

Or with it from the start:

bash
curl -LsSf https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.sh | bash -s -- --with knowledge
PowerShell
$env:SYNAPSE_WITH='knowledge'; irm https://github.com/synapseorch-ai/synapse-ai/releases/latest/download/setup.ps1 | iex

Other ways

With npm or pip

npm

npm
npm install -g synapse-orch-ai
synapse

Needs Node.js 18 or newer.

pip

pip
pip install synapse-orch-ai
synapse

Needs Python 3.11 to 3.14 and Node.js 20.9 or newer.

Ports, volumes, Compose and scale mode: Docker. Every option, and uninstalling: the install guide.

Rather not run it yourself?

SynapseOrch Cloud is the same engine, managed for you, with models included.

Request an invite