---
id: setup
title: Setup
sidebar_label: Setup
---

### Requirements

- OS: MacOS, Windows, Linux
- VSCode 1.39.2+
- Git

### Install

Install CodeRoad from [this link in the VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=CodeRoad.coderoad).

Once installed, reload the window (`ctrl/cmd + R`) to get started.

### Start

![CodeRoad Example](/gif/coderoad-example.gif)

To start the extension, inside VSCode:

- Open an **empty** VSCode workspace (a project folder)
- Launch the app from the VSCode command palette. How?
  - select “View” > “Command Palette” from the top panel OR press `cmd/ctrl + shift + P`
  - in the command palette popup, search for and run `CodeRoad:Start`
