> For the complete documentation index, see [llms.txt](https://docs.runtimeverification.com/simbolik/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.runtimeverification.com/simbolik/overview/getting-started.md).

# Getting started

Simbolik is still in the early development phase. This guide walks you through the necessary steps to gain access to the beta version.

### TL;DR

* [Install Foundry](#install-foundry)
* [Get a free API key](#get-a-free-api-key)
* [Install the Simbolik VSCode extension](#installing-the-vscode-extension)
* [Configure your API key in the extension settings](#configure-your-api-key-in-the-extension-settings)

### Install Foundry

Simbolik depends on Foundry to compile your smart contracts.

Please follow the [official installation instructions](https://book.getfoundry.sh/getting-started/installation) to setup Foundry on your system.

### Get a free API key

The beta version requires a free API key. You can get it by logging into our [website](https://simbolik.runtimeverification.com/) using either GitHub, Google, or MetaMask as an authentication provider.

<figure><img src="/files/ornoyTqUZO1BoHhuQh7R" alt=""><figcaption></figcaption></figure>

After logging in you can copy your API key.&#x20;

<figure><img src="/files/ReOazOUkp1TSkRb10Cow" alt=""><figcaption></figcaption></figure>

## Installing the VSCode extension

The VSCode extension is conveniently available as a VSCode extension. To install it, open the Extensions panel and search for "simbolik":

<figure><img src="/files/pbCUW08Arpeydv9yWj71" alt=""><figcaption></figcaption></figure>

### Configure your API key in the extension settings

Finally, you need to configure your extension to use your API key.

First, open the extension settings:

<figure><img src="/files/Yfid7BsC1camckEOFmE0" alt=""><figcaption></figcaption></figure>

Second, paste your API key in the corresponding field:

<figure><img src="/files/OFkNNOxOceXEoiEj08Kb" alt=""><figcaption></figcaption></figure>

That's it! You're now fully set up. Read on to start your first debugging session.