Skip to content

App Registry

The TFGrid App Registry catalogs official and verified community applications that can be deployed using tfgrid-compose. Applications listed here are discoverable at registry.tfgrid.studio and can be deployed with a simple command:

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

# Deploy community app
tfgrid-compose up username/app-name

# Deploy from any git URL
tfgrid-compose up https://gitlab.com/org/app

How It Works

For Users

  1. Browse Apps: Visit registry.tfgrid.studio
  2. Deploy: Run tfgrid-compose up <app-name> (v0.10.0+)
  3. Done: App is automatically cloned and deployed

No configuration needed - apps include their own tfgrid-compose.yaml.

For Developers

Apps in the registry:

  • Include tfgrid-compose.yaml in their repository
  • Follow app guidelines
  • Can be submitted for verification via PR

Official Apps

Maintained by TFGrid Studio:

tfgrid-ai-agent

AI coding agent with Qwen integration.

tfgrid-compose up tfgrid-ai-agent

Details: - Pattern: single-vm - Repo: tfgrid-studio/tfgrid-ai-agent - Docs: AI Agent Guide

Community Apps

Community-contributed apps that have passed verification:

Ready to share your app? Submit it for verification!
See Submission Guidelines →

Using Apps

Deploy Official App

# Deploy with auto-generated name
tfgrid-compose up tfgrid-ai-agent
# → Deployment name: tfgrid-ai-agent

# Deploy with custom name
tfgrid-compose up tfgrid-ai-agent --name=dev
# → Deployment name: dev

Deploy Community App (Unverified)

# From GitHub
tfgrid-compose up username/repo-name

# From any git URL
tfgrid-compose up https://gitlab.com/org/app

⚠️ Security Note: Always review code before deploying unverified apps!

List Available Apps

# Search registry
tfgrid-compose search

# Search by keyword
tfgrid-compose search ai

# Get app details
tfgrid-compose info tfgrid-ai-agent

Manage Cached Apps

# Pull/update app
tfgrid-compose pull tfgrid-ai-agent

# List cached apps
tfgrid-compose cache

# Clean unused apps
tfgrid-compose prune

App Structure

All apps must include tfgrid-compose.yaml:

name: my-app
version: 1.0.0
description: My application

patterns:
  recommended: single-vm

resources:
  cpu:
    recommended: 4
  memory:
    recommended: 8192
  disk:
    recommended: 100

hooks:
  setup: deployment/setup.sh
  configure: deployment/configure.sh
  healthcheck: deployment/healthcheck.sh

See App Manifest Reference for full specification.

Registry Structure

Apps are organized by verification status:

Official Apps

  • Maintained by TFGrid Studio
  • Full support and documentation
  • Production-ready

Verified Apps

  • Community-contributed
  • Code reviewed by TFGrid Studio
  • Security checked
  • Documentation verified

Unverified Apps

  • Any GitHub/GitLab repo
  • Use at your own risk
  • Not listed in registry
  • Access via direct URL

Submitting Your App

Want to share your app with the community?

  1. Develop Your App
  2. Include tfgrid-compose.yaml
  3. Add deployment scripts

  4. Write comprehensive README

  5. Test Locally 

    tfgrid-compose up ./my-app

  6. Submit for Verification

  7. Fork tfgrid-studio/app-registry
  8. Add your app to registry/verified/community.yaml

  9. Create pull request

  10. Review Process

  11. Code review (~3 days)
  12. Security check
  13. Testing

  14. Documentation review

  15. Approved!

  16. Merged to registry
  17. Appears in tfgrid-compose search
  18. Listed on registry.tfgrid.studio

Full Guide: How to Submit →

App Cache Location

Apps are cached locally:

~/.config/tfgrid-compose/
├── apps/                    # Cached app repositories
│   ├── tfgrid-ai-agent/
│   └── other-apps/
├── deployments/             # Your deployments
└── registry.yaml            # Cached registry

Version Pinning

Pin apps to specific versions:

# Latest version (default)
tfgrid-compose up tfgrid-ai-agent

# Specific version
tfgrid-compose up tfgrid-ai-agent:v0.9.0

# Specific branch
tfgrid-compose up tfgrid-ai-agent:develop

Registry API

For automation and integrations:

# JSON API
curl https://registry.tfgrid.studio/api/apps.json

# YAML API
curl https://registry.tfgrid.studio/api/apps.yaml

# App details
curl https://registry.tfgrid.studio/api/apps/tfgrid-ai-agent.json

Security

Official Apps

  • ✅ Audited by TFGrid Studio
  • ✅ Regular security updates
  • ✅ Full support

Verified Apps

  • ✅ Code reviewed
  • ✅ Security checked
  • ✅ No hardcoded secrets
  • ✅ Documentation verified

Unverified Apps

  • ⚠️ Use at your own risk
  • ⚠️ Review code before deploying
  • ⚠️ Check for secrets/malicious code

Best Practice: Always inspect app code before deployment:

# Clone and inspect
git clone https://github.com/username/app
cd app
# Review code, check for secrets
less deployment/setup.sh

# Deploy if satisfied
tfgrid-compose up ./app

Resources

Registry Deployment: v0.10.0 (CLI integration coming soon)
Browse Apps Now: registry.tfgrid.studio

TFGrid Studio Ecosystem

Integrated tools and resources