truffle command reference

truffle discovers EC2 capacity — finding instance types, comparing spot prices, checking quotas, and reporting capabilities. This is the exhaustive command and flag reference. For an overview and workflows see the truffle guide.

Generated reference

This page is generated from the truffle CLI itself and kept in sync by a release-gated drift check, so every command and flag below matches the shipped binary. For task-oriented walkthroughs see the guides.

Global flags

These apply to every truffle command.

Flag	Short	Type	Default	Description
--accessibility		bool		Enable accessibility mode (implies --no-emoji)
--account		string		Expected AWS account ID (optional guard)
--lang		string		Language for output (en, es, fr, de, ja, pt)
--no-color		bool		Disable colorized output
--no-emoji		bool		Disable emoji in output
--output	-o	string	table	Output format (table, json, yaml, csv)
--profile		string		AWS named profile (overrides SPORE_PROFILE/AWS_PROFILE and the shared config)
--region		stringSlice		Alias for --regions
--regions	-r	stringSlice		Filter by specific regions (comma-separated)
--verbose	-v	bool		Enable verbose output

truffle app

List and inspect streamable research applications available in the spore.host catalog.

truffle app

truffle app list

List all streamable applications in the catalog

truffle app list

truffle az

Search for instance types with an availability zone-first perspective. This command prioritizes showing which specific AZs support each instance type, making it ideal for multi-AZ deployments and capacity planning.

Examples:

Find which AZs have m7i.large

truffle az m7i.large

Search in specific AZs only

truffle az m7i.large --az us-east-1a,us-east-1b

Find instances available in at least 3 AZs per region

truffle az "m8g.*" --min-az-count 3

Show AZ availability summary

truffle az "c7i.xlarge" --output json

truffle az [instance-type-pattern] [flags]

Flags:

Flag	Short	Type	Default	Description
--az		stringSlice		Filter by specific availability zones (e.g., us-east-1a,us-west-2b)
--min-az-count		int		Minimum number of AZs required per region
--regions-only		bool		Show only regions that meet AZ count requirement
--timeout		duration	5m0s	Timeout for AWS API calls

truffle capacity-blocks

Discover purchasable EC2 Capacity Block for ML offerings (read-only).

This queries DescribeCapacityBlockOfferings — "what can I reserve?" — and shows each offering's id, instance type/count, AZ, reservation window (in your local timezone), duration, and up-front price. The offering id is what 'spawn capacity-block purchase' reserves. Offerings are listed cheapest-first by default (--sort start to order by start time instead).

Durations are day-granular: use --days (e.g. --days 1), or --duration-hours, which is rounded up to a valid Capacity Block duration (1-day steps to 14 days, then 7-day steps to 182). By default the search covers now → the soonest a block of that duration could end; use --start-date / --start-after / --end-by to widen or shift the window (blocks can start up to 8 weeks out).

For Capacity Blocks you ALREADY own, use 'truffle capacity --blocks' instead.

Examples: truffle capacity-blocks --instance-type p5.48xlarge --days 1 truffle capacity-blocks --instance-type p5.48xlarge --start-date 2026-07-01 --days 2 truffle capacity-blocks --instance-type p5.48xlarge --duration-hours 48
--region us-east-1 --sort start --output json

truffle capacity-blocks [flags]

Flags:

Flag	Short	Type	Default	Description
--count		int	1	Number of instances in the block
--days		int		Capacity Block duration in days (natural unit for CB-for-ML; e.g. --days 1). Overrides --duration-hours
--duration-hours		int		Capacity Block duration in hours (e.g. 24); use --days for whole days
--end-by		string		Latest block END time (RFC3339). Default: start + duration + 1d cushion
--instance-type		string		Instance type to find offerings for (required, e.g. p5.48xlarge)
--sort		string	price	Sort offerings by: price (cheapest first) or start (soonest first)
--start-after		string		Earliest block START time (RFC3339, e.g. 2026-07-01T00:00:00Z). Default: now
--start-date		string		Search for blocks starting on this calendar day (YYYY-MM-DD), in UTC
--timeout		duration	5m0s	Timeout for AWS API calls

truffle capacity

Check ML capacity reservations across AWS regions.

Supports both Capacity Blocks (training workloads) and On-Demand Capacity Reservations (ODCRs) for GPU and ML instances.

Examples:

Check all reservations

truffle capacity

GPU instances only

truffle capacity --gpu-only

Capacity Blocks for ML

truffle capacity --blocks

Available capacity only

truffle capacity --available-only

truffle capacity [flags]

Flags:

Flag	Short	Type	Default	Description
--active-only		bool	true	Only show active reservations (default: true)
--available-only		bool		Only show reservations with available capacity
--blocks		bool		Show Capacity Blocks for ML (training workloads)
--gpu-only		bool		Only show GPU/ML instance reservations
--instance-types		stringSlice		Filter by instance types (comma-separated)
--min-capacity		int		Minimum available capacity
--odcr		bool	true	Show On-Demand Capacity Reservations (default)
--timeout		duration	5m0s	Timeout for AWS API calls

truffle find

Find EC2 instance types using natural language, glob patterns, or regex.

Auto-detects query type:

• Patterns: m7i*, c[6-8]i.large, g5.* → pattern matching
• Natural language: "graviton 8 cores 32gb" → spec-based search

Understands:

• CPU vendors: intel, amd, graviton, nvidia
• Processors: emerald rapids, sapphire rapids, ice lake, genoa, turin, milan
• GPUs: h200, h100, a100, b200, b300, l40s, l4, a10g, t4, rtx, inferentia, trainium
• Specs: 8 cores, 8 physical cores, 32gb, 4 gpus
• Sizes: tiny, small, medium, large, huge
• Architecture: x86_64, arm64
• Network: efa, 10gbps, 25gbps, 50gbps, 100gbps, 200gbps, 400gbps
• Sort hints: cheap/cheapest, fast/fastest, newest/latest

Examples: truffle find "m7i*" (glob pattern) truffle find "c[6-8]i.large" (regex pattern) truffle find graviton (vendor search) truffle find "turin 32 cores 64gb" --exact (exact spec match) truffle find "8 physical cores 32gb" (physical core count) truffle find "cheap graviton 8 cores" (sorted by price) truffle find nvidia (all NVIDIA GPU instances) truffle find "h100 efa" (GPU + network)

truffle find <query> [flags]

Flags:

Flag	Short	Type	Default	Description
--app		string		Application name from catalog (e.g. paraview, igv)
--exact		bool		Match exact vCPU and memory values instead of minimum
--pick-first		bool		Output only the top result's instance type (useful for piping to spawn)
--service		string	ec2	Instance namespace to search: ec2 or sagemaker (ml.* types)
--show-query		bool		Show parsed query details
--show-quota		bool		Show the per-type training-job quota (SageMaker only)
--skip-azs		bool		Skip availability zone lookup (faster)
--timeout		duration	5m0s	Timeout for AWS API calls

truffle list

List available EC2 instance types, families, or sizes.

Examples: truffle list --family truffle list --sizes truffle list --region us-east-1

truffle list [flags]

Flags:

Flag	Short	Type	Default	Description
--family		bool		List instance families (e.g., m5, c5, r5)
--region		string	us-east-1	Region to query for listing (default: us-east-1)
--sizes		bool		List available sizes (e.g., large, xlarge, 2xlarge)

truffle quotas

Display current quotas, usage, and available capacity for EC2 and SageMaker instances.

Requires AWS credentials to be configured.

Examples:

Show EC2 quotas for default region

truffle quotas

Show quotas for specific regions

truffle quotas --regions us-east-1,us-west-2

Show only GPU quotas

truffle quotas --family P

Show SageMaker ml.* instance quotas

truffle quotas --service sagemaker --regions us-west-2

Show SageMaker g5 quotas only

truffle quotas --service sagemaker --family g5 --regions us-west-2

Generate quota increase requests

truffle quotas --service sagemaker --family g5 --request

truffle quotas [flags]

Flags:

Flag	Short	Type	Default	Description
--family		string		Filter by instance family (EC2: Standard/G/P/Inf/Trn; SageMaker: g5/p4d/etc.)
--request		bool		Generate quota increase request commands
--service		string	ec2	Service to query: ec2 (default) or sagemaker

truffle search

Deprecated: use 'find' instead — it auto-detects patterns vs natural language queries

Search for instance types across AWS regions.

Supports glob patterns (m7i*, c7?) and regex (c[6-8]i.large, (p4d|p5)..*) for flexible matching.

truffle search [instance-type-pattern] [flags]

Flags:

Flag	Short	Type	Default	Description
--architecture		string		Filter by architecture (x86_64, arm64, i386)
--family		string		Filter by instance family (e.g., m5, c5)
--min-memory		float64		Minimum memory in GiB
--min-vcpu		int		Minimum number of vCPUs
--nested-virtualization		bool		Only types supporting nested virtualization (KVM/Hyper-V in-instance)
--pick-first		bool		Output only the top result's instance type (useful for piping to spawn)
--service		string	ec2	Instance namespace to search: ec2 or sagemaker (ml.* types)
--show-price		bool		Show on-demand pricing (uses static pricing data)
--show-quota		bool		Show the per-type training-job quota (SageMaker only)
--skip-azs		bool		Skip availability zone lookup (faster but less detailed)
--timeout		duration	5m0s	Timeout for AWS API calls

truffle spot

Search for Spot instance pricing and availability across AWS regions.

Shows current Spot prices, savings vs On-Demand, and price history.

Examples:

Spot prices for m7i.large

truffle spot m7i.large

Filter by max price

truffle spot "m7i.*" --max-price 0.10

Sort by price

truffle spot "c7.*" --sort-by-price

truffle spot [instance-type-pattern] [flags]

Flags:

Flag	Short	Type	Default	Description
--active-only		bool		Only show AZs with active Spot capacity
--local-zones		bool		Include local zones in results (excluded by default)
--lookback-hours		int	1	Hours to look back for price history (1-720)
--max-price		float64		Maximum Spot price per hour (USD)
--pick-first		bool		Output only the top result's instance type (useful for piping to spawn)
--show-savings		bool		Show savings vs On-Demand pricing
--sort-by-price		bool		Sort by price (cheapest first)
--timeout		duration	5m0s	Timeout for AWS API calls

truffle version

Display version, build date, and git commit information for truffle.

truffle version