Skip to main content
Version: 1.5.0

CLI Reference

thresh provides a comprehensive set of commands for managing WSL development environments, AI-powered blueprint generation, and MCP server integration.

New in v1.5.0

Thresh v1.5.0 introduces networking and storage features:

  • Port mapping and forwarding for WSL environments
  • Persistent volumes and bind mounts
  • New commands: thresh start and thresh stop for lifecycle management
  • WSL configuration profiles for database optimization

Quick Overview

CommandDescription
upProvision a new environment from a blueprint
startStart a stopped environment and apply port forwarding
stopStop a running environment and remove port forwarding
listList all thresh-managed environments
destroyRemove an environment
blueprintManage blueprints (list, generate, delete)
blueprint listList available blueprints
blueprint generateGenerate custom blueprint using AI
blueprint deleteDelete a generated blueprint
chatInteractive AI chat for environment planning
distrosList available distributions
distroManage custom distributions
configManage configuration settings
wslconfManage WSL configuration profiles
volumeManage persistent volumes
serveStart MCP server
metricsShow performance metrics
versionShow version information

Command Categories

Environment Management

  • up - Create new environments
  • start - Start stopped environments (v1.5.0)
  • stop - Stop running environments (v1.5.0)
  • list - View all environments
  • destroy - Remove environments

Blueprint Management

AI Features

  • chat - Interactive AI assistant

Configuration

  • config - Manage settings
  • distro - Custom distributions
  • distros - View distributions
  • wslconf - WSL configuration profiles (v1.5.0)

Storage

  • volume - Manage persistent volumes (v1.5.0)

Integration

  • serve - MCP server for AI editors

Information

Global Options

All commands support these global options:

OptionDescription
--help, -hShow help information
--verbose, -vEnable verbose output
--quiet, -qSuppress non-error output
--versionShow version information

Getting Help

For any command, use --help to see detailed usage:

thresh --help               # Show all commands
thresh up --help # Show help for 'up' command
thresh config --help # Show help for 'config' command

Exit Codes

thresh uses standard exit codes:

CodeMeaning
0Success
1General error
2Invalid arguments
3WSL not available
4Environment not found
5Configuration error

Examples

See individual command pages for detailed examples and use cases.