Skip to content

Getting Started with taskcat

Welcome to taskcat! This section will get you up and running with AWS CloudFormation template testing in minutes.

What You'll Learn

📦 Installation

Multiple installation methods including pip, Docker, and from source.

Install taskcat

🚀 Quick Start

Run your first test in under 5 minutes with our step-by-step guide.

Quick Start

⚙️ Configuration

Master taskcat configuration for advanced testing scenarios.

Configure

Learning Path

Follow this recommended path to master taskcat:

1. Installation (5 minutes)

Get taskcat installed on your system with your preferred method.

2. Quick Start (10 minutes)

Create and run your first test to understand the basics.

3. Configuration (20 minutes)

Learn about advanced configuration options and best practices.

4. Dynamic Values (15 minutes)

Master runtime-evaluated parameters for flexible testing.

Prerequisites

Before you begin, ensure you have:

  • AWS Account with appropriate permissions
  • Python 3.8+ installed on your system
  • AWS CLI configured with credentials
  • Basic CloudFormation knowledge

Quick Installation

# Install taskcat via pip
pip install taskcat

# Verify installation
taskcat --version

# Get help
taskcat --help

Your First Test

# .taskcat.yml
project:
  name: my-first-test
  regions:
    - us-east-1

tests:
  basic:
    template: template.yaml
    parameters:
      BucketName: $[taskcat_autobucket]

# Run the test
taskcat test run

Need Help?

Ready to begin? Start with Installation!