Installation

The inz CLI is a single binary — no runtime dependencies, no package manager required.

Requires Postgres 14+

instancez connects to a PostgreSQL server you provide. Version 14 or later is required. Older versions are untested and some migrations will fail on them. Any standard Postgres works, whether it’s a local install or a managed service like Neon or RDS.

Code functions require Node.js

If you plan to use code functions (functions: block in instancez.yaml), you’ll need Node.js 22+ and npm installed. instancez checks for node at startup and refuses to boot if it’s missing while functions are declared. Everything else (auth, database, storage, RLS) works without them.

Install Node.js (which includes npm) from nodejs.org or via your system package manager.

One-line install

macOS

curl -fsSL https://get.instancez.ai | sh

Installs inz to ~/.local/bin. If that directory isn’t in your PATH, the script will tell you.

Linux

curl -fsSL https://get.instancez.ai | sh

Installs inz to ~/.local/bin. Works on x86-64 and ARM64.

Windows

irm https://get.instancez.ai/windows | iex

Installs inz.exe to %LOCALAPPDATA%\instancez\bin. Run in PowerShell 5.1+.

Alternatively, download the .exe directly and place it anywhere on your PATH.

Verify the install:

inz version

inz sends anonymous usage and error telemetry. Turn it off with inz telemetry disable or INSTANCEZ_TELEMETRY_DISABLED=1. See Telemetry.

Manual download

Each link points at the binary for the latest release:

Platform	Download
macOS (Apple Silicon)	inz_darwin_arm64
macOS (Intel)	inz_darwin_amd64
Linux x86-64	inz_linux_amd64
Linux ARM64	inz_linux_arm64
Windows x86-64	inz_windows_amd64.exe
Windows ARM64	inz_windows_arm64.exe

For a specific version instead, browse all releases.

On macOS or Linux, make the binary executable, rename it, and move it onto your PATH:

chmod +x inz_darwin_arm64
mv inz_darwin_arm64 ~/.local/bin/inz

Updating

Re-run the install command to update to the latest release. The script overwrites the existing binary.

Uninstalling

Delete the binary:

macOS / Linux

rm ~/.local/bin/inz

Windows

Remove-Item "$env:LOCALAPPDATA\instancez\bin\inz.exe"

What’s next

• Quick Start — create a project and have an API running in minutes