Installation guides

Pick the guide that matches your scenario — from a 60-second quickstart to full step-by-step setup for multi-device networks.

Quickstart

Install env-sync in under a minute. One command, no accounts, no server. Covers install, init, and first sync.

Quickstart →

Trusted Peers (SSH)

Step-by-step guide for trusted-owner-ssh mode. Add your first device, onboard more machines, enable encryption, and remove devices.

Trusted Peers guide →

Secure Peers (mTLS)

Step-by-step guide for secure-peer mode. Invitation-based onboarding, mTLS authentication, AGE encryption, and peer revocation.

Secure Peers guide →

Quick install (all modes)

# system-wide install
curl -fsSL https://envsync.arnav.tech/install.sh | sudo bash

# user-only install (no sudo)
curl -fsSL https://envsync.arnav.tech/install.sh | bash -s -- --user

The installer defaults to the CLI. Add --all to install both the CLI and desktop GUI, or use --gui-only if you only want the GUI app.

# install both CLI + GUI
curl -fsSL https://envsync.arnav.tech/install.sh | bash -s -- --user --all

# install only the GUI
curl -fsSL https://envsync.arnav.tech/install.sh | bash -s -- --user --gui-only

Prefer a desktop app?

env-sync also ships an optional desktop GUI built with Wails. It uses the same configuration, secrets, keys, and peer registry as the CLI, so you can install one or both and switch between them at any time.

For the full GUI walkthrough, platform notes, and development details, see GUI.md.

Not sure which guide?

Scenario	Guide
Just trying it out, single machine	Quickstart
All machines are yours (laptop, desktop, server)	Trusted Peers
Multiple people sharing secrets, no SSH access to each other	Secure Peers