Getting Started

Welcome to redteamer. This quick guide will help you install, explore, and run your first module in minutes.

What is redteamer?

redteamer is a single CLI binary that gives offensive security teams a unified way to run the tools they already rely on for adversary emulation and high touch pentesting.

Instead of juggling enumeration utilities, C2s, and custom scripts by hand, you describe your operations as modules that define what they need, what they do, and what they output.

redteamer packages and executes modules, passes data between them, captures artifacts, and logs every run, all on your assessment VMs with no additional infrastructure or cloud services required.

Quick Start

1. Install redteamer

Quick install with curl:

curl https://redteamer.io/install | sh

Or follow the full installation guide for details.

2. Verify Installation

Check that the CLI works:

rt version

You should see the current release number and architecture.

3. Discover Modules

List modules from your local or imported sources:

rt search

4. Run Modules

To run your first module, try something simple like:

rt run core/utils/whoami

This will execute and record the output under your audit history.

5. Audit Results

Check recent runs:

rt audit

Inspect a run’s output:

rt output <run-id>

This helps you confirm that everything is working before chaining modules or writing custom playbooks.

Official Support

If you've found a bug, have a feature suggestion, or a billing question, please raise an issue on our Support Portal.

We welcome your feedback.