Skip to main content

SyftBox Cheatsheet

A set of useful snippets and one-liners which you can use as a reference to get things done quickly ⚡️

Installations​

Install SyftBox​

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

Install a SyftBox API​

Local development​

important

Make sure you have the latest version of the SyftBox repository cloned on your local machine:

git clone https://github.com/OpenMined/syft.git

Also, make sure you have just installed.

note

The following commands need to be run from the syft directory (the repository root), unless otherwise specified.

Start a local dev server​

Start a local server on localhost:5001:

just run-server # just rs

Start a local server on localhost:5002:

just run-server 5002 # just rs 5002

Start a local dev client​

Start a local client on a random port with email alice@openmined.org

just run-client alice # just rc alice