____         __ _   ____
/ ___| _   _ / _| |_| __ )  _____  __
\___ \| | | | |_| __|  _ \ / _ \ \/ /
 ___) | |_| |  _| |_| |_) | (_) >  <
|____/ \__, |_|  \__|____/ \___/_/\_\
       |___/

Quickstart User Installation

SyftBox 1 liner

curl -LsSf https://syftbox.openmined.org/install.sh | sh -s -- run

Manual install

install uv

curl -LsSf https://astral.sh/uv/install.sh | sh

create a virtualenv somewhere

uv venv .venv

Install Syftbox

uv pip install -U syftbox

run the client

uv run syftbox client

Quickstart Client Developer Installation

Step 0: Open your terminal to the root of this Github repository

Begin by opening your terminal and navigating to the root directory of this github repository (so when you run 'ls' it should show folders like "syftbox", "server", "tests", etc.). Then run the commands in steps 1-4:

Step 1: Install Homebrew

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Step 2: Install uv (using homebrew — which is better for this than pip)

brew install uv

Step 3: Install a virtual environment using uv

uv venv

Step 4: Install a relative version of uv.

uv pip install -e .

Step 5: Run the client

uv run syftbox/client/client.py

Alternative Options

Run Client

syftbox client --config_path=./config.json --sync_folder=~/Desktop/SyftBox [email protected] --port=8082  --server=https://syftbox.openmined.org

Staging Server

If you have issues or want to use a bleeding edge server try --server=https://syftboxstage.openmined.org

Deploy

This builds the latest source to a wheel and deploys and restarts the server: https://syftbox.openmined.org

./scripts/deploy.sh

Dev Mode

Run the server and clients locally in editable mode with: Server:

./scripts/server.sh

Client1:

./scripts/madhava.sh

Client2:

./scripts/andrew.sh