Skip to content
Switch branches/tags
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time

The Chaos Toolkit documentation

Build Requirements Status

Get to the documentation of the Chaos Toolkit.

Contribute to the documentation

This project is based on MkDocs, a Python documentation generator based on Markdown.

To get started, install Python 3 on your machine, a virtual environment and install the dependencies using pip as follows:

$ pip install -r requirements.txt

Once the dependencies are installed you need to ensure you have also installed any submodules (i.e. source code for the docs is in a separate submodule) using:

$ git submodule update --init

Finally you can start a local server to view the docs:

$ mkdocs serve

If you wish to contribute to this documentation, please submit a PR with your changes for review.