> For the complete documentation index, see [llms.txt](https://docs.scribble.codes/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.scribble.codes/master.md).

# Introduction

Scribble is a runtime verification tool for Solidity that transforms annotations in the [Scribble specification language](/language/introduction.md) into concrete assertions that check the specification. In other words, Scribble transforms existing contracts into contracts with equivalent behaviour, except that they also check properties. With these *instrumented* contracts, you can use testing, fuzzing or symbolic execution (for example using Mythril or the MythX service) to check if your properties can be violated.

![Scribble overview](/files/-MNy_uW3glpo-4Gw9ghx)

{% hint style="warning" %}
Scribble is currently in beta, and both the tool and the language are still changing and under active development.
{% endhint %}

## Tutorials

To get started quickly check out these tutorials:

* [In-place testing with Scribble](/tutorials/in-place-testing-with-scribble.md)
* [Property Checking with Scribble and MythX](/tutorials/property-checking-with-scribble-and-mythx.md)
* [Property Checking with Scribble and Mythril](/tutorials/property-checking-with-scribble-and-mythril.md)

## Documentation

This documentation has two categories: **Tool** and **Language**.

To get started using the Scribble CLI (**Tool**), check out the [Installation](/tool/installation.md) and [CLI Usage](/tool/cli-usage.md) pages.

Also be sure to check out the page on [arming and disarming](/tool/cli-usage/arm-and-disarm.md), which explains how to use Scribble to do "in place" instrumentation. For a deep dive into instrumentation, and to debug any issues, check out the [Instrumented Code](/tool/instrumented-code.md) and [Debugging](/tool/instrumented-code/debugging-instrumented-code.md) pages.

To get started learning about the Scribble specification **language**, start [here](/master.md).

{% hint style="info" %}
If you encounter any issues feel free to find us in the #scribble-spec-langauge channel of the [MythX Discord Server](https://discord.gg/TJGV3T7Y7V), or file an [issue](https://github.com/ConsenSys/scribble/issues/) on GitHub.
{% endhint %}

## Code

You can find the code on github - <https://github.com/ConsenSys/scribble>.