Skip to main content
Version: 1.7.0

Tutorials

Comprehensive guides to get the most out of thresh, from quick starts to advanced AI integration.

Getting Started​

Quick Start (5 Minutes)​

Get your first thresh environment running in just 5 minutes.

You'll learn:

  • Install thresh on Windows
  • Choose and provision a blueprint
  • Enter and use your environment
  • Basic environment management

Time: 5 minutes
Difficulty: Beginner

Environment Creation​

Creating Custom Blueprints​

Build your own environment templates tailored to your exact workflow.

You'll learn:

  • Blueprint file structure and syntax
  • Package management for different distributions
  • Post-install scripts and environment variables
  • Real-world blueprint examples
  • Testing and sharing blueprints

Time: 20 minutes
Difficulty: Intermediate

Networking & Storage​

Networking & Port Mapping​

Configure port mapping, exposed ports, and network settings for containerized workloads.

You'll learn:

  • Map host ports to container ports
  • Bind to specific network interfaces
  • Configure container hostnames
  • Automatic netsh forwarding on Windows

Time: 15 minutes
Difficulty: Intermediate

Persistent Volumes​

Set up persistent storage for data that survives environment recreation.

You'll learn:

  • Named volumes for database data
  • Bind mounts for live code editing
  • Tmpfs for fast temporary storage
  • Volume lifecycle management

Time: 15 minutes
Difficulty: Intermediate

Stack Orchestration (Hub-Managed)​

Deploying Multi-Service Stacks​

Deploy multi-service applications through the Thresh Hub dashboard and API.

You'll learn:

  • Write stack definition JSON files with dependency ordering
  • Use ${service.host} / ${service.port} variable injection
  • Deploy stacks through the Hub UI and REST API
  • Perform rolling updates on individual services
  • Use CLI commands (thresh auth, thresh node, thresh cluster) alongside Hub-managed stacks

Time: 20 minutes
Difficulty: Intermediate

Fleet Management​

Fleet Management with Thresh Hub​

Connect your thresh nodes to a centralized Hub for fleet-wide visibility and orchestration.

You'll learn:

  • Deploy and configure Thresh Hub and mid-tier
  • Connect agents with API key authentication (thresh_live_* / thresh_mid_*)
  • Monitor node health and metrics in real-time
  • Manage remote nodes with thresh node and thresh cluster
  • Three-tier architecture (Hub → Mid-Tier → Agents)

Time: 30 minutes
Difficulty: Advanced

AI Integration​

GitHub Copilot SDK Configuration​

Set up AI-powered environment management with GitHub Copilot in VS Code.

You'll learn:

  • Configure thresh as an MCP server
  • Use natural language to manage environments
  • Generate blueprints with AI assistance
  • Best practices for AI-driven development

Time: 10 minutes
Difficulty: Beginner

VS Code MCP Integration​

Deep dive into Model Context Protocol integration for advanced AI workflows.

You'll learn:

  • MCP protocol fundamentals
  • Configure multiple AI clients (Copilot, Claude, Cline)
  • Available tools and capabilities
  • Advanced server configuration
  • Debugging and troubleshooting

Time: 30 minutes
Difficulty: Advanced

Tutorial Path​

Beginner Track​

  1. Quick Start - Get started (5 min)
  2. GitHub Copilot SDK - AI integration (10 min)
  3. Creating Custom Blueprints - Customization (20 min)

Total: 35 minutes

Intermediate Track​

  1. Networking & Port Mapping - Networking (15 min)
  2. Persistent Volumes - Storage (15 min)
  3. Deploying Multi-Service Stacks - Stacks (20 min)

Total: 50 minutes

Advanced Track​

  1. Creating Custom Blueprints - Blueprint development (20 min)
  2. VS Code MCP Integration - Advanced AI (30 min)
  3. Fleet Management - Hub & fleet (30 min)

Total: 80 minutes

Team Onboarding​

  1. Quick Start - Everyone (5 min)
  2. Creating Custom Blueprints - Team leads (20 min)
  3. Deploying Stacks - DevOps (20 min)
  4. Fleet Management - Infra team (30 min)

Total: 75 minutes

Additional Resources​

CLI Reference:

Guides:

Community:

Contributing Tutorials​

Have a great thresh workflow? Share it with the community!

How to contribute:

  1. Fork the thresh repository
  2. Create tutorial in website/docs/tutorials/
  3. Follow existing format and style
  4. Submit pull request

See CONTRIBUTING.md for details.

Need help? Visit GitHub Discussions or open an issue.