syftbox installation made effortless

pip install syft-installer
import syft_installer as si
si.install_and_run_if_needed()

Why We Built This

privacy should be effortless

🚫 Privacy is inconvenient

Privacy tools shouldn't require technical expertise or complex setup. They should just work, seamlessly and automatically.

🏢 Data is siloed

Your data is trapped in corporate platforms. It should be yours to control, share, and use however you choose.

⛓️ Users aren't free

People are locked into systems that exploit their data. True freedom means owning and controlling your digital life.

See It In Action

privacy can be effortless

Under the Hood

Here's what SyftBox daemon creates when installed

# SyftBox creates a complete local environment:

~/.syftbox/
  ├── config.json          # Authentication and server settings
  ├── logs/                 # Daemon and application logs
  └── cache/                # Downloaded binaries and temp files

~/SyftBox/
  ├── apps/                 # Installed SyftBox applications
  └── datasites/            # Connected data sources and sites

# Plus the daemon binary at ~/.local/bin/syftbox

The Complete API

effortless setup and teardown of syftbox daemon

Quick Start

import syft_installer as si

si.install_and_run_if_needed() # Install and start
si.install()         # Install only
si.run()             # Start if already installed

Status & Control

si.status()
si.is_installed()
si.is_running()

si.stop()
si.run_if_stopped()

Non-Interactive Mode

session = si.install("email@example.com", interactive=False)
session.submit_otp("ABC123")
print(session.is_authenticated)

Clean Uninstall

# Removes everything
si.uninstall()

# Confirms before deleting

try it out

experience syftbox installation in google colab

open in colab