> 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="https://3687854359-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWhAuD1DmzZoWPS62YwmQ%2Fuploads%2FHfwBepFhpjx2432awfPx%2Fimage.png?alt=media&amp;token=6543a96a-8fd1-4a15-abf1-ebfe2b054ab7" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3687854359-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWhAuD1DmzZoWPS62YwmQ%2Fuploads%2F2Yk8ab1HwCRUkykSg4XM%2Fimage.png?alt=media&amp;token=d165cab8-2410-4c1c-8775-44f547f99a85" 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="https://3687854359-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWhAuD1DmzZoWPS62YwmQ%2Fuploads%2F3KtRslhc1w1YNvXd3jPa%2Fimage.png?alt=media&amp;token=7438757e-697e-41c6-865a-dfaedd81809f" 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="https://3687854359-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWhAuD1DmzZoWPS62YwmQ%2Fuploads%2FNTGQg7RpVYZcRCaMs0MA%2Fimage.png?alt=media&amp;token=5dbef884-f195-4eeb-87a9-84e228785cc6" alt=""><figcaption></figcaption></figure>

Second, paste your API key in the corresponding field:

<figure><img src="https://3687854359-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FWhAuD1DmzZoWPS62YwmQ%2Fuploads%2FLhBndRxR9KFvcCMixjax%2Fimage.png?alt=media&amp;token=a8dd2024-585e-442c-8f79-73e38db0e15a" alt=""><figcaption></figcaption></figure>

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