Prerequisites
- Python 3.10 or higher
- Truffle¹
- The TruffleOS desktop client
Install Python
Download and install Python from python.org or use Chocolatey:choco install python --version=3.10.0
sudo apt update
sudo apt install python3.10 python3.10-venv python3-pip
Set Up Your Environment
Choose your preferred method for managing Python environments:
Create and activate a virtual environment:source .venv/bin/activate
.venv\Scripts\Activate.ps1
If you prefer uv for faster package management:# Install uv if you haven't already
curl -LsSf https://astral.sh/uv/install.sh | sh
# Create a virtual environment
uv venv
# Activate it
source .venv/bin/activate # macOS/Linux
# or
.venv\Scripts\Activate.ps1 # Windows
Install Truffile
With your environment activated, install the SDK:
Verify the installation:
You should see:
🍄🟫 truffile - TruffleOS SDK
Usage: truffile <command> [options]
Commands:
scan Scan network for Truffle devices
connect <device> Connect to a Truffle device
disconnect <device|all> Disconnect and clear credentials
deploy [path] Deploy an app (reads type from truffile.yaml)
list <apps|devices> List installed apps or devices
models List AI models on connected device
proxy Start OpenAI-compatible inference proxy
Examples:
truffile scan # find devices on network
truffile connect truffle-6272
truffile deploy ./my-app
truffile deploy # uses current directory
truffile list apps
truffile models # show loaded models
truffile proxy # start proxy on :8080
Make sure you’ve already onboarded your Truffle with the desktop client and created an account before proceeding.
Next Steps
Now that you have Truffile installed, head to the CLI guide to connect to your Truffle device.