Skip to content
// 001

Quick Install

One command to install Convex and add it to your PATH

macOS / Linux

curl -fsSL https://convex.world/install.sh | bash

Works on macOS, Linux, and Windows via WSL or Git Bash.

Windows PowerShell

irm https://convex.world/install.ps1 | iex

Run in PowerShell. Creates a convex command available system-wide.

Requires Java 21+. The installer checks and will tell you if Java is missing.

// 002

Direct Download

Download convex.jar and run it with java -jar

All Releases

Browse all versions with changelogs. Pin to a specific version for production deployments.

GitHub Releases

First run: the jar is not code-signed, so double-clicking it can trigger a Gatekeeper (macOS) or SmartScreen (Windows) prompt. Running it from a terminal with java -jar convex.jar avoids that. To keep double-clicking: on macOS right-click the jar and choose Open once (or run xattr -dr com.apple.quarantine convex.jar); on Windows choose More info, then Run anyway.

// 003

Docker

Run a Convex peer in a container

1

Pull the image

docker pull convexlive/convex:latest
2

Run a peer

docker run -p 8080:8080 -p 18888:18888 convexlive/convex

The image starts a peer by default, serving the HTTP API on port 8080 and the peer protocol on port 18888. Available tags: latest (stable) or a specific version like 0.8.18. View on Docker Hub

// 004

Build from Source

Clone the repository and build with Maven

1

Clone the repository

git clone https://github.com/Convex-Dev/convex.git
2

Build

cd convex && mvn clean install

Requires Java 21+ and Maven 3.7+. The built JAR is at convex-integration/target/convex.jar