TFGrid Studio Documentation¶

Complete development platform for ThreeFold Grid

Build, deploy, and scale decentralized applications with tfgrid-compose CLI and integrated tools.

🌐 New here? Check out our main website for an overview of TFGrid Studio, pricing, and features.

🎯 What is TFGrid Studio?¶

TFGrid Studio is a complete development platform for ThreeFold Grid. The flagship tool, tfgrid-compose, brings docker-compose-style simplicity to decentralized deployments.

# Deploy any application with one command
tfgrid-compose up my-app

No vendor lock-in. Industry standards. Decentralized infrastructure.

✨ Current Status¶

✅ Production Ready (v0.10.0)¶

Component	Status	Description
tfgrid-compose	✅ v0.10.0	Universal orchestrator with registry integration
tfgrid-ai-agent	✅ v0.10.0	AI coding agent (reference application)
tfgrid-gitea	🆕 v1.0.0	Self-hosted Git service with web interface
Single-VM Pattern	✅ Production	Deploy isolated VMs with private networking
Gateway Pattern	✅ Production	Multi-VM with public access and SSL
K3s Pattern	✅ Production	Full Kubernetes cluster deployment
App Registry	✅ v0.10.0	Deploy apps by name from registry
Context Files	✅ Production	Simplified workflow with `.tfgrid-compose.yaml`

🔨 In Progress (v0.10.1) - 95% Complete!¶

Component	Status	Description
Login/Logout UX	✅ Complete	Enhanced credential management
ThreeFold Setup Guide	✅ Complete	Complete DIY onboarding documentation
Config Management	✅ Complete	`tfgrid-compose config` commands
Docs Command	✅ Complete	Open docs in browser
Enhanced Error Messages	✅ Complete	Helpful guidance throughout CLI
Release	🔄 Testing	Final testing before release

🚧 Coming Soon¶

Component	Status	Timeline	Description
AI Gateway Integration	📋 Planned	v0.11.0 (Nov)	AI agent + Gateway + Gitea workflow
AI Dashboard Web UI	📋 Planned	v0.12.0 (Dec-Jan)	Visual project management
Voice Coding	📋 Planned	v0.13.0 (Feb)	"Vibe code by talking" interface
CI/CD Integration	📋 Planned	v0.13.0+	GitHub Actions, GitLab CI
Web Dashboard	📋 Planned	Q2 2026	Complete visual management
Managed Service	📋 Planned	Q3 2026+	Email + credit card deployments

🚀 Quick Start¶

1. Install tfgrid-compose¶

# One-line installer
curl -sSL install.tfgrid.studio/install.sh | sh

# Verify installation
tfgrid-compose --version

2. Set Up ThreeFold¶

Need a ThreeFold wallet with TFT? See the complete setup guide.

Already have a wallet? Configure it:

tfgrid-compose login
# Enter your seed phrase when prompted

3. Deploy an App¶

# Deploy official app (v0.10.0+)
tfgrid-compose up tfgrid-ai-agent

# Or use local path (current)
tfgrid-compose up ../tfgrid-ai-agent

# Or specify app path
tfgrid-compose up ../tfgrid-ai-agent

That's it! Your application is now running on ThreeFold Grid. 🎉

📚 Documentation Overview¶

Getting Started¶

Introduction - What is TFGrid Compose and why use it
Installation - Install and configure tfgrid-compose
ThreeFold Setup - Complete DIY guide (wallet, TFT, KYC)
Quick Start - Deploy your first application in 5 minutes
Core Concepts - Understand patterns, apps, and manifests

Deployment Patterns¶

Pattern Overview - Understanding the pattern system
Single-VM Pattern - ✅ Production ready
Gateway Pattern - ✅ Production ready
K3s Pattern - ✅ Production ready

Applications¶

Application Overview - How apps work in TFGrid Compose
TFGrid AI Agent - ✅ AI coding agent
TFGrid Gitea - 🆕 Self-hosted Git service
Creating Apps - Build your own deployable apps

CLI Reference¶

CLI Commands - Complete command reference
App Manifest - tfgrid-compose.yaml specification
Context File - .tfgrid-compose.yaml usage
State Management - How state is tracked
Environment Variables - Configuration options

Guides¶

App Registry - 🆕 Deploy apps by name (v0.10.0+)
Migration Guide - Migrate from standalone repos
Advanced Deployment - Production deployment strategies
Networking - WireGuard and Mycelium setup
Security - Security best practices
Troubleshooting - Common issues and solutions

Architecture¶

Design Decisions - Why we built it this way
Source Repositories - Acknowledgment of source work
Comparison - vs standalone repos, vs other platforms

Roadmap¶

Platform Roadmap - 🚀 Now / Next / Later
Now - Active Development - What we're building
Next - Planned Features - What's coming
Later - Future Concepts - Long-term vision

Contributing¶

Contributing Guide - How to contribute
Code of Conduct - Community guidelines
Security Policy - Report security issues

Development¶

Submit Your App - Share your app with the community
Pattern Contract - How patterns communicate
Pattern Development - Create custom patterns
Versioning Policy - Version management

🎯 Use Cases¶

Deploy isolated AI coding environments on ThreeFold Grid.

tfgrid-compose up tfgrid-ai-agent

Web Applications¶

Deploy web apps with public IPv4, SSL, and reverse proxy.

tfgrid-compose up my-webapp --pattern=gateway --domain=myapp.com

Cloud-Native Apps¶

Deploy microservices on Kubernetes clusters.

tfgrid-compose up my-saas --pattern=k3s

Databases¶

Deploy databases with persistent storage and private networking.

tfgrid-compose up my-postgres --pattern=single-vm

💡 Why TFGrid Compose?¶

✅ No Vendor Lock-in¶

Uses industry standards: Terraform, Ansible, Kubernetes. Your apps aren't locked to ThreeFold Grid.

✅ Simple & Powerful¶

Heroku-like UX with production-ready patterns. One command to deploy, full control when needed.

✅ Decentralized Infrastructure¶

Runs on ThreeFold Grid: decentralized compute, no single point of failure, cost-effective.

✅ Open Source¶

Apache 2.0 license. Free to use, modify, and distribute. Community-driven development.

✅ Battle-Tested¶

Built from proven, working implementations: - Gateway pattern: Based on mik-tf/tfgrid-gateway - K3s pattern: Based on ucli-tools/tfgrid-k3s - AI agent: Based on mik-tf/tfgrid-ai-agent