🍄‍🟫 Truffile

Python SDK/CLI for Truffle devices.

What It Does

  • discovers and connects to your Truffle (scan, connect, disconnect)
  • copies bundled agent resources into your workspace (load)
  • validates and deploys apps from truffile.yaml (validate, deploy)
  • manages installed apps (list apps, delete)
  • talks to inference directly (models, chat)

Start making your Own Apps

  • app schema and validation: truffile/truffile/schema/app_config.py
  • schedule parsing: truffile/truffile/schedule.py
  • deploy planning + builder flow: truffile/truffile/deploy/builder.py
  • generated TruffleOS protos vendored in: truffile/truffle/
  • bundled example apps live under truffile/app-store/
  • bundled Codex skills live under truffile/skills/

truffile.yaml defines:

  • metadata (name, description, type)
  • process (cmd, working_directory, environment)
  • files to upload
  • optional run/build commands
  • background schedule policy (for BG apps)

App Types and Runtime Model

Apps can be:

  • foreground (fg): exposes MCP tools that tasks/agents can call during active execution
  • background (bg): runs on schedule and emits context for proactivity, enabling the device to trigger actions and write/update memory
  • both (fg + bg): one app package can provide MCP tools and scheduled context emission

How to think about it:

  • FG path is tool-serving: app process is used as a callable capability surface (MCP)
  • BG path is context/proactivity: scheduled runs feed the proactive agent with fresh signals
  • Proactivity can take actions and persist memory based on BG outputs

In practice:

  • use fg when you need direct tool invocation from tasks
  • use bg when you need periodic monitoring, summaries, or event-driven context
  • use both when the same app should both expose tools and continuously feed proactivity/memory

Core Commands

truffile scan
truffile connect <device>
truffile create [app_name]
truffile load all
truffile validate [app_dir]
truffile deploy [app_dir]
truffile deploy --dry-run [app_dir]
truffile list apps --json
truffile delete <app-name>
truffile models
truffile chat

truffile create scaffolds a hybrid app starter with:

  • truffile.yaml (foreground + background process config)
  • copy-file steps for generated *_foreground.py and *_background.py
  • icon.png copied from docs/Truffle.png (deploy requires an icon)

truffile load all copies bundled agent-readable resources into your current workspace:

  • ./truffile/skills/ for CLI/chat/infer/app-creation skills
  • ./truffile/examples/ for bundled example apps such as ArXiv, Exa, Notion, Obsidian, Viator, WHOOP, and Home Assistant

Use truffile load skills or truffile load examples to copy only one group.

Obsidian Bridge Workflow

For a local Obsidian vault on your laptop, truffile can run a small host-side bridge and deploy a bundled foreground app to the device:

truffile obsidian attach --vault ~/Documents/abd-vault
truffile obsidian serve
truffile obsidian deploy

Use truffile obsidian status to inspect the saved bridge configuration. The bridge stores a scoped bearer token in the local truffile state file and the bundled app uses that token to read, write, list, and search notes in the configured vault.

In truffile chat, runtime controls are slash commands (not launch flags):

  • /help for all chat commands
  • /config to show current chat config
  • /reasoning on|off
  • /stream on|off
  • /json on|off
  • /tools on|off
  • /max_tokens <int>, /temperature <float|off>, /top_p <float|off>, /max_rounds <int>
  • /models to switch model
  • /attach <path-or-url> to attach an image for the next user message (local path or http(s) URL)
  • /system <text|clear>
  • /mcp connect <http(s)://...>, /mcp tools, /mcp status, /mcp disconnect

Inference Interfaces

Direct IF2:

  • list models: GET /if2/v1/models
  • chat completions: POST /if2/v1/chat/completions

CLI wrappers:

  • truffile models
  • truffile chat (streaming by default)

Proto Sync

Refresh vendored protos from firmware repo:

./scripts/sync_protos.sh

Development Loop

The supported app development loop is CLI-first:

truffile create my-app --path ./apps
truffile validate ./apps/my-app
truffile deploy --dry-run ./apps/my-app
truffile deploy ./apps/my-app

After deploy, use truffile chat to attach the app to a task and exercise its tools with the on-device agent. Use truffile delete to remove test apps from the connected device.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.3.21)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for deepshard from gravatar.com deepshard Avatar for deepshard-abd from gravatar.com deepshard-abd

License

MIT

Requires

Python >=3.12

Provides Extra

dev

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

truffile-0.3.7.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

truffile-0.3.7-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

Details for the file truffile-0.3.7.tar.gz.

File metadata

  • Download URL: truffile-0.3.7.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for truffile-0.3.7.tar.gz
Algorithm Hash digest
SHA256 8f515b5302817a8e3d882860f05656d5bca3a9d12491eff33908105b5fa9edba
MD5 e9504ff0ba22f88375581fe268e4aca5
BLAKE2b-256 94de685e53c6febf792396bbab2893b7f343f417fb3e83c641c719ea3d34be1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for truffile-0.3.7.tar.gz:

Publisher: publish-truffile.yml on deepshard/pyfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file truffile-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: truffile-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 1.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for truffile-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2d5b8b82c49110af6d52e68cf792cb3cb5df5d593698dcebae9ab3f91b8a206d
MD5 d16d9518825dd9fd465923fb85c65cb6
BLAKE2b-256 15ecf759c9a8eb7e553f94af3c020ec60ed025c5a1ce95bcdba67739591c931b

See more details on using hashes here.

Provenance

The following attestation bundles were made for truffile-0.3.7-py3-none-any.whl:

Publisher: publish-truffile.yml on deepshard/pyfw

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.21

2 files

0.3.20

2 files

0.3.19

2 files

0.3.18

2 files

0.3.17

2 files

0.3.16

2 files

0.3.15

2 files

0.3.14

2 files

0.3.13

2 files

0.3.11

2 files

0.3.10

2 files

0.3.9

2 files

0.3.8

2 files

This release

0.3.7 This release

2 files

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.35

2 files

0.1.33

2 files

0.1.31

2 files

0.1.29

2 files

0.1.27

2 files

0.1.25

2 files

0.1.23

2 files

0.1.21

2 files

0.1.19

2 files

0.1.17

2 files

0.1.14

2 files

0.1.12

2 files

0.1.11

2 files

0.1.8

2 files

0.1.7

2 files

Pre-release

0.1.dev4

2 files

Pre-release

0.1.dev1

2 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page