> For the complete documentation index, see [llms.txt](https://jewels86.gitbook.io/tourmaline/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://jewels86.gitbook.io/tourmaline/overview.md).

# Overview

Welcome to the Tourmaline documentation! In this overview, you'll learn:

* What Tourmaline is
* How to install `tourmaline`
* Basic `tourmaline` usage
* The format of these docs

{% hint style="warning" %}
These docs are still IN PROGRESS! Some pages may be inaccurate/unfinished.
{% endhint %}

## What is Tourmaline?

**Tourmaline** is a command-line web enumeration tools. It's made to help pentesters gather information about a target website. Tourmaline includes the following tools:

* A web spider (directory enumeration)
* A brute forcer (directory enumeration)
* A CMS detector
* A file and data scraper 

## How do I use Tourmaline?

Tourmaline can be installed by downloading the [latest release](https://github.com/jewels86/Tourmaline/releases) and unpacking it with:

```bash
sudo dpkg -i [FILE_NAME]
```

Where `[FILE_NAME]` is the name of the file you downloaded. 

{% hint style="info" %}
Tourmaline is currently only available for Debian Linux. Windows users should install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
{% endhint %}

Once the `tourmaline` command has been installed, you can delete the downloaded file.

### Usage

The `tourmaline` command uses basic POSIX syntax. It has 6 commands:

* `tourmaline spider`
* `tourmaline brute`
* `tourmaline cms`
* `tourmaline scan`
* `tourmaline fscraper`
* `tourmaline dscraper`