Skip to main content

Get SynthOrg

The CLI orchestrates Docker: it writes a Compose file, verifies and pulls the images, and brings the stack up. Pre-alpha; see the roadmap.

Quick Install

Needs Docker Engine 20.10+ with Compose, running, and network access for the first pull.

Linux / macOS

bash 
$ curl -sSfL https://synthorg.io/get/install.sh | bash

Windows (PowerShell)

PowerShell
─ □ ✕ 
PS> irm https://synthorg.io/get/install.ps1 | iex

Then set up and start the platform:

>_ terminal 
$ synthorg init      # setup wizard: data dir, secrets, compose file
$ synthorg start     # verify signatures, pull images, start the stack

Dashboard at http://localhost:3000, API at http://localhost:3001, by default. synthorg status and synthorg stop manage the stack.

Other Options

🔎

Look before you pipe

Review the exact scripts the install commands run. They download a binary from GitHub Releases, verify its SHA-256 checksum against the release manifest, and install it to a directory on your PATH. Each release also includes SLSA Level 3 provenance attestations for independent verification.

View install.sh View install.ps1

Direct Download

Download the install scripts and run them locally instead of piping from the network.

install.sh

Linux / macOS

install.ps1

Windows

Then run: bash install.sh, or on Windows powershell -ExecutionPolicy Bypass -File .\install.ps1

Manual Binary

Skip the install script and grab the binary directly from GitHub Releases.

  1. 1 Download your platform's archive from the latest release (.tar.gz, or .zip on Windows), alongside checksums.txt
  2. 2 Verify on Linux with sha256sum --ignore-missing -c checksums.txt. On macOS run shasum -a 256 <archive>, and on Windows Get-FileHash <archive> -Algorithm SHA256, then compare the digest against the archive's line in checksums.txt
  3. 3 Extract and move to your PATH

Each release includes SLSA L3 provenance; verify with gh attestation verify <archive> -R Aureliolo/synthorg (docs).

Skip the CLI entirely

The CLI automates Compose generation, secrets, signature-verified image pulls, health checks, and updates. To do it by hand, copy docker/.env.example to docker/.env, fill in the blank secrets, and bring up docker/compose.yml.

Manual Docker Compose setup