Getting Started with ThreatForest¶

Welcome to ThreatForest! This guide will help you get up and running with AI-powered threat modeling in minutes.

Installation Steps¶

Step 1: Install ThreatForest¶

# Install pipx if you don't have it
python3 -m pip install --user pipx
python3 -m pipx ensurepath

# Install ThreatForest
git clone https://github.com/aws-samples/sample-agentic-attack-tree-generator.git
cd ThreatForest
pipx install .

# Run ThreatForest
threatforest

# Clone repository
git clone https://github.com/aws-samples/sample-agentic-attack-tree-generator.git
cd ThreatForest

# Create virtual environment
python3 -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install
pip install .

# Run ThreatForest
threatforest

Step 2: Configure AWS Bedrock¶

Configure your AWS credentials for Bedrock access:

Option 1: AWS Profile (Recommended)

Configure an AWS profile that the ThreatForest wizard will use:

# Configure AWS profile
aws configure --profile your-profile-name
# AWS Access Key ID: [your-access-key]
# AWS Secret Access Key: [your-secret-key]
# Default region name: us-east-1
# Default output format: json

# Test Bedrock access
aws bedrock list-foundation-models --region us-east-1 --profile your-profile-name

When you run threatforest, the wizard will prompt you to: - Select your AWS profile name - Specify the AWS region (e.g., us-east-1)

Option 2: AWS Access Keys (Alternative)

Alternatively, you can provide AWS access keys directly when prompted by the wizard.

Step 3: Prepare Your Project¶

At minimum, ThreatForest needs one of the following in your project directory:

• ThreatComposer file (.tc.json) - Recommended, created at threat-composer
• README.md - Application description and architecture overview
• Architecture diagrams - PNG, PDF, Mermaid, or other diagram formats

Quick Setup:

your-project/
├── README.md              # Describes your application
└── MyApp.tc.json         # Your threat model

Step 4: Run Your First Analysis¶

# Launch the interactive wizard
threatforest

The wizard will guide you through:

1. Workflow Selection - Choose Full Analysis, Enrichment, or Mitigation
2. Project Location - Specify project directory path
3. AWS Configuration - Select AWS profile (if using Bedrock)
4. Model Selection - Choose AI model
5. Execution - Watch real-time progress
6. Results - View summary and output files

Next Steps¶

Now that you have ThreatForest installed, explore these guides:

Need Help?¶

Having issues? Check the FAQ Troubleshooting section for common problems and solutions.