> ## Documentation Index
> Fetch the complete documentation index at: https://flowdeck.studio/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Install and Setup

> Get FlowDeck up and running

FlowDeck is an extension for Cursor and other VS Code-based editors, available for macOS.

## Prerequisites

Before installing FlowDeck, ensure you have:

<Steps>
  <Step title="Recent macOS running on an Apple Silicon Mac">
    <Warning>
      Windows and Linux are not supported.
    </Warning>

    * Apple Silicon Mac (M1 or higher)
    * macOS 13 (Ventura) or higher
  </Step>

  <Step title="Xcode">
    <Info>
      FlowDeck uses Xcode's internal tools to build and debug your apps.
    </Info>

    * Download from the [Mac App Store](https://apps.apple.com/us/app/xcode/id497799835?mt=12) (14.0 or later)
    * Launch Xcode at least once to install components
    * Accept the license agreement
  </Step>

  <Step title="Xcode Command Line Tools">
    Install the latest command line tools

    ```bash theme={null}
    xcode-select --install
    ```
  </Step>

  <Step title="Download your preferred editor">
    <Info>
      FlowDeck is compatible with Cursor and other VS Code-based editors
    </Info>

    * [Cursor](https://cursor.com/) (1.0 or higher)
    * [Visual Studio Code](https://code.visualstudio.com/download) (1.85 or higher)
    * [Windsurf](https://windsurf.com) (1.0 or higher)
  </Step>
</Steps>

## Installation

### Install FlowDeck

<Tabs>
  <Tab title="Marketplace (Cursor, VS Code, most editors)">
    1. Open Cursor
    2. Click Extensions icon in sidebar (⌘⇧X)
    3. Search for "FlowDeck"
    4. Click **Install** on FlowDeck
    5. Reload Cursor when prompted

    <Info>
      If you don't see it listed, try the "Direct Download" method instead.
    </Info>
  </Tab>

  <Tab title="Direct Download">
    1. Head to the [Open-VSX Registry Page](https://open-vsx.org/extension/flowdeck/FlowDeck)
    2. Click the Download Link (Bottom-Right)
    3. In your Editor, use: `⌘⇧P` → "Install from VSIX"
    4. Select the downloaded file
    5. Reload the editor when prompted
  </Tab>
</Tabs>

### Verify Installation

After installation, you should see:

* FlowDeck icon in the Activity Bar (left sidebar)
* "FlowDeck" in the Extensions list
* FlowDeck commands in the Command Palette (`⌘⇧P` → type "FlowDeck")

### Set up Xcode-style shortcuts (Optional)

If you're coming from Xcode, FlowDeck can automatically set up the most common shortcuts for you, so you feel at home.

1. Open Command Palette: `Cmd+Shift+P`
2. Search for "Setup Xcode-style Keyboard Shortcuts"

You can also enable or disable this via FlowDeck Settings in Settings > Extensions > FlowDeck > System Configuration.

For more info about what shortcuts are available, check out the [Xcode-style shortcuts section](/extension/xcode-style-shortcuts).
