Documentation

Chaos Kitten Developer Hub

Learn how to contribute, extend, and understand the internal architecture of Chaos Kitten. Get started with our guides below.

Architecture OverviewInternal Design

Chaos Kitten is built on a modular architecture to allow easy extension of attacks and scanners.

  • The Brain: Parses OpenAPI specs and plans attacks using LLM or heuristics.
  • The Paws: Executes HTTP requests against the target API with various adapters.
  • The Litterbox: Generates reports in multiple formats (HTML, SARIF, JSON).
  • Scanner: The core engine that orchestrates the entire process.
ContributingJoin Us

We welcome contributions! To get started with development:

git clone https://github.com/mdhaarishussain/chaos-kitten.git cd chaos-kitten pip install -e '.[dev]' pytest

See CONTRIBUTING.md for more details.

Project StructureFile Tree
  • chaos_kitten/brain/: Planning logic & strategies
  • chaos_kitten/paws/: Network execution
  • chaos_kitten/litterbox/: Reporting modules
  • website/: This documentation site
  • tests/: Comprehensive test suite
Resources