Skip to content

Installation

Requirements

Before installing Toolbox, ensure you have:

  • Python 3.12 or later
  • uv - Fast Python package installer

Install from PyPI

The recommended way to install Toolbox:

uv tool install --prerelease allow --python 3.12 -U syft-toolbox

Verify the installation:

tb info

Install from Source

For development or latest features:

git clone https://github.com/OpenMined/toolbox.git
cd toolbox
uv pip install -e .

Troubleshooting

CLang Issues

If you encounter CLang errors during installation:

uv python install --reinstall

This fixes Python in uv.

C++ Include Errors

If you see #include <string> errors:

CXXFLAGS="-isystem $(xcrun --show-sdk-path)/usr/include/c++/v1" uv pip install -e .

Permission Issues

If you get permission errors, ensure you have write access to the uv tool directory. You may need to use sudo or adjust your PATH.

Next Steps

After installation, proceed to the Quick Start guide to install your first MCP server.