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

# Welcome to Windsurf

> Download and install Windsurf IDE for Mac, Windows, or Linux. Import VS Code or Cursor settings, configure themes, and start coding with AI-powered assistance.

Tomorrow's editor, today.

Windsurf is a next-generation AI IDE built to keep you in the flow. On this page, you'll find instructions on how to install Windsurf on your computer, navigate the onboarding flow, and get started with your first AI-powered project.

<Card
  title="Cascade"
  icon={
  <svg
    width="25"
    height="25"
    viewBox="0 0 1292 1292"
    fill="none"
    xmlns="http://www.w3.org/2000/svg"
  >
    <path
      d="M1195 599C1195 848.08 993.08 1050 744 1050C494.92 1050 293 848.08 293 599C293 349.92 494.92 148 744 148C993.08 148 1195 349.92 1195 599ZM411.5 599C411.5 782.635 560.365 931.5 744 931.5C927.635 931.5 1076.5 782.635 1076.5 599C1076.5 415.365 927.635 266.5 744 266.5C560.365 266.5 411.5 415.365 411.5 599Z"
      fill="#34E8BB"
    />
    <path
      d="M1096.19 1053.62C1116.8 1078.03 1113.86 1114.77 1087.65 1133.04C1002.41 1192.46 903.441 1229.92 799.584 1241.61C676.505 1255.46 552.082 1232.51 442.049 1175.65C332.016 1118.79 241.314 1030.58 181.415 922.172C130.87 830.693 104.172 728.301 103.33 624.396C103.071 592.449 131.338 568.79 163.173 571.479C195.007 574.168 218.29 602.208 219.218 634.143C221.573 715.175 243.206 794.78 282.679 866.22C331.512 954.6 405.457 1026.51 495.161 1072.87C584.866 1119.22 686.302 1137.94 786.643 1126.64C867.75 1117.51 945.198 1089.11 1012.66 1044.15C1039.24 1026.44 1075.58 1029.21 1096.19 1053.62Z"
      fill="#34E8BB"
    />
    <path
      d="M177.334 450.08C146.261 442.514 126.947 411.072 137.349 380.829C160.687 312.983 195.56 249.512 240.566 193.267C285.571 137.023 339.851 89.0802 400.928 51.4326C428.153 34.6511 463.065 46.5999 477.261 75.2582C491.457 103.917 479.508 138.389 452.641 155.738C406.542 185.506 365.436 222.584 330.994 265.627C296.552 308.67 269.39 356.906 250.456 408.411C239.421 438.428 208.408 457.646 177.334 450.08Z"
      fill="#34E8BB"
    />
  </svg>
}
  href="/windsurf/cascade"
>
  Your agentic chatbot that can collaborate with you like never before.
</Card>

<CardGroup cols={2}>
  <Card title="Usage" icon="bars-progress" href="/windsurf/accounts/usage">
    Credits and usage.
  </Card>

  <Card title="Terminal" icon="terminal" href="/windsurf/terminal">
    An upgraded Terminal experience.
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="MCP" icon="hammer" href="/windsurf/cascade/mcp">
    MCP servers extend the agent's capabilities.
  </Card>

  <Card title="Memories" icon="cloud-word" href="/windsurf/cascade/memories">
    Memories and rules help customize behavior.
  </Card>

  <Card title="Context Awareness" icon="brain" href="/context-awareness/overview">
    Instantly understands your codebase.
  </Card>

  <Card title="Advanced" icon="gears" href="/windsurf/advanced">
    Advanced configuration options.
  </Card>
</CardGroup>

<CardGroup cols={2}>
  <Card title="Workflows" icon="list" href="/windsurf/cascade/workflows">
    Automate repetitive trajectories.
  </Card>

  <Card title="App Deploys" icon="rocket" href="/windsurf/cascade/app-deploys">
    Deploy applications in one click.
  </Card>
</CardGroup>

<Tip> See what's new with Windsurf in our [changelog](https://windsurf.com/changelog)! </Tip>

<Note>
  In some cases Windsurf may not function exactly as referenced, or documentation may be out of date.
</Note>

## Set Up

To get started, please ensure that your device meets the requirements, click the download link, and follow the instructions to install and run Windsurf.

[Click here](#update-windsurf) if you're looking for how to update Windsurf.

<Tabs>
  <Tab title="Mac">
    Minimum OS Version: OS X Yosemite

    <a href="https://windsurf.com/windsurf/download_mac" target="_blank" rel="noopener noreferrer">
      <button style={{width: '170px', backgroundColor: '#34E8BB', color: 'white', padding: '5px 10px', border: 'none', borderRadius: '5px', cursor: 'pointer', fontSize: '0.8rem', display: 'flex', justifyContent: 'center'}}>Download for Mac</button>
    </a>
  </Tab>

  <Tab title="Windows">
    Minimum OS Version: Windows 10

    <a href="https://windsurf.com/windsurf/download" target="_blank" rel="noopener noreferrer">
      <button style={{width: '170px', backgroundColor: '#34E8BB', color: 'white', padding: '5px 10px', border: 'none', borderRadius: '5px', cursor: 'pointer', fontSize: '0.8rem', display: 'flex', justifyContent: 'center'}}>Download for Windows</button>
    </a>
  </Tab>

  <Tab title="Ubuntu">
    Minimum OS Version: >= 20.04 (or glibc >= 2.31, glibcxx >= 3.4.26)

    <a href="https://windsurf.com/windsurf/download_linux" target="_blank" rel="noopener noreferrer">
      <button style={{width: '170px', backgroundColor: '#34E8BB', color: 'white', padding: '5px 10px', border: 'none', borderRadius: '5px', cursor: 'pointer', fontSize: '0.8rem', display: 'flex', justifyContent: 'center'}}>Download for Ubuntu</button>
    </a>
  </Tab>

  <Tab title="Other Linux distributions">
    Minimum OS Version: glibc >= 2.28, glibcxx >= 3.4.25

    <a href="https://windsurf.com/windsurf/download_linux" target="_blank" rel="noopener noreferrer">
      <button style={{width: '170px', backgroundColor: '#34E8BB', color: 'white', padding: '5px 10px', border: 'none', borderRadius: '5px', cursor: 'pointer', fontSize: '0.8rem', display: 'flex', justifyContent: 'center'}}>Download for Linux</button>
    </a>
  </Tab>
</Tabs>

## Onboarding

Once you have Windsurf running, you will see the page below. Let's get started! Note that you can always restart this onboarding flow with the "Reset Onboarding" command.

<Frame>
  <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/welcome.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=f8eae97bf290f1badc7b21e0d9566f89" width="2344" height="1464" data-path="assets/windsurf/onboarding/welcome.png" />
</Frame>

### 1. Select setup flow

If you're coming from VS Code or Cursor, you can easily import your configurations. Otherwise, select "Start fresh". You can also optionally install `windsurf` in PATH such that you can run `windsurf` from your command line.

<Frame>
  <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/setup.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=5696da6d3a63cd10ddcac4575dbf89fd" width="2064" height="1145" data-path="assets/windsurf/onboarding/setup.png" />
</Frame>

<Tabs>
  <Tab title="Start fresh">
    Choose your keybindings here, either default VS Code bindings or Vim bindings.

    <Frame>
      <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/keybind.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=14c9adde7dd5bb1073108c510934f3cb" width="2484" height="1378" data-path="assets/windsurf/onboarding/keybind.png" />
    </Frame>
  </Tab>

  <Tab title="Import from VS Code">
    You can migrate your settings, extensions, or both here.

    <Frame>
      <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/vscode_migration.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=cf14f085ccba168dd02c791f381507b7" width="2486" height="1378" data-path="assets/windsurf/onboarding/vscode_migration.png" />
    </Frame>
  </Tab>

  <Tab title="Import from Cursor">
    You can migrate your settings, extensions, or both here.

    <Frame>
      <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/vscode_migration.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=cf14f085ccba168dd02c791f381507b7" width="2486" height="1378" data-path="assets/windsurf/onboarding/vscode_migration.png" />
    </Frame>
  </Tab>
</Tabs>

### 2. Choose editor theme

Choose your favorite color theme from these defaults! Don't worry, you can always change this later. Note that if you imported from VS Code, your imported theme will override this.

<Frame>
  <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/theme.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=7bd1ce64f97063988605a7e6bcf3f734" width="2482" height="1380" data-path="assets/windsurf/onboarding/theme.png" />
</Frame>

### 3. Sign up / Log in

To use Windsurf, you need to use your Windsurf account or create one if you don't have one. Signing up is completely free!

<Frame>
  <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/auth.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=e92373636e9415e67b79e5eaeff399be" width="2346" height="1468" data-path="assets/windsurf/onboarding/auth.png" />
</Frame>

Once you've authenticated correctly, you should see this page. Hit "Open Windsurf" and you're good to go!

<Frame>
  <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/authenticated.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=8d8091bca31c571afe1ef5caf9b03459" width="2348" height="1464" data-path="assets/windsurf/onboarding/authenticated.png" />
</Frame>

#### Having Trouble?

If you're having trouble with this authentication flow, you can also log in and manually provide Windsurf with an authentication code.

<Tabs>
  <Tab title="1. Select &#x22;Having Trouble?&#x22;">
    Click the "Copy link" button to copy an authentication link to your clipboard and enter this link into your browser.

    <Frame>
      <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/manual_auth.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=c4aabe6e213b964e315fbc6940f0c5b0" width="2478" height="1376" data-path="assets/windsurf/onboarding/manual_auth.png" />
    </Frame>
  </Tab>

  <Tab title="2. Enter Authentication Code">
    Copy the authentication code displayed in the link and enter it into Windsurf.

    <Frame>
      <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/manual_auth_onboarding.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=5911333c632d5ded717d685c3ff77cac" width="1990" height="1858" data-path="assets/windsurf/onboarding/manual_auth_onboarding.png" />
    </Frame>
  </Tab>
</Tabs>

### 4. Let's Surf!

<Frame>
  <video autoPlay muted loop playsInline src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/onboarding/lets_surf.mp4?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=8f26c1a8770b94a299752d7401149cff" data-path="assets/windsurf/onboarding/lets_surf.mp4" />
</Frame>

<Card title="Recommended Plugins" icon="puzzle-piece" href="/windsurf/recommended-plugins">
  Explore some of our recommended plugins to get the most out of Windsurf!
</Card>

## Update Windsurf

To update Windsurf, you can click on the "Restart to Update ->" button in the top right corner of the menu bar.

<Frame>
  <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/update-windsurf.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=254e39b2e81a7746d82b36387dae2504" width="600" height="66" data-path="assets/windsurf/update-windsurf.png" />
</Frame>

If you are not seeing this button, you can:

1. Click on your Profile icon dropdown > Check for Updates

2. In the Command Palette (`Cmd/Ctrl+Shift+P`) > "Check for Updates"

## Things to Try

Now that you've successfully opened Windsurf, let's try out some of the features! These are all conveniently accessible from the starting page. :)

<AccordionGroup>
  <Accordion title="Write with Cascade">
    <Frame>
      <img src="https://mintcdn.com/codeium/qJj_RRojefb93yIg/assets/windsurf/cascade.png?fit=max&auto=format&n=qJj_RRojefb93yIg&q=85&s=1e48173bc3499c03f11be933a6b45596" width="2062" height="1548" data-path="assets/windsurf/cascade.png" />
    </Frame>

    On the right side of the IDE, you'll notice a new panel called "Cascade". This is your AI-powered code assistant! You can chat, write code, and run code with Cascade! Learn more about how it works [here](/windsurf/cascade).
  </Accordion>

  <Accordion title="Generate a project with Cascade">
    <Frame>
      <img src="https://mintcdn.com/codeium/qJj_RRojefb93yIg/assets/windsurf/cascade_generate.png?fit=max&auto=format&n=qJj_RRojefb93yIg&q=85&s=876d94d833f7156fb19ced5da29ac3f9" width="2062" height="1548" data-path="assets/windsurf/cascade_generate.png" />
    </Frame>

    You can create brand new projects with Cascade! Click the "New Project" button to get started.
  </Accordion>

  <Accordion title="Open Folder / Connect to Remote Server">
    <Frame>
      <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/open_workspace.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=23af27c11317a2d69cb04f092e1da13f" width="2062" height="1548" data-path="assets/windsurf/open_workspace.png" />
    </Frame>

    You can open a folder or connect to a remote server via SSH or a local dev container. Learn more [here](/windsurf/advanced).
  </Accordion>

  <Accordion title="Configure Windsurf Settings">
    <Frame>
      <img style={{width: '50%', display: 'block', margin: 'auto'}} src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/windsurf-settings-panel.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=4f123cb41fe4557a31249af717324652" width="754" height="986" data-path="assets/windsurf/windsurf-settings-panel.png" />
    </Frame>

    Click on the "Windsurf - Settings" button on the bottom right to pop up the settings panel. To access Advanced Settings, click on the button in this panel or select "Windsurf Settings" in the top right profile dropdown.
  </Accordion>

  <Accordion title="Open Command Palette">
    <Frame>
      <img src="https://mintcdn.com/codeium/qJj_RRojefb93yIg/assets/windsurf/command_palette.png?fit=max&auto=format&n=qJj_RRojefb93yIg&q=85&s=8fb19cd757b7daa72bf441aa71d30a7f" width="2058" height="1544" data-path="assets/windsurf/command_palette.png" />
    </Frame>

    You can open the command palette with the `⌘+⇧+P` (on Mac) or `Ctrl+Shift+P` (on Windows/Linux) shortcut. Explore the available commands!
  </Accordion>
</AccordionGroup>

## Forgot to Import VS Code Configurations?

You can easily import your VS Code/Cursor configuration into Windsurf if you decide to do so after the onboarding process.

Open the command palette (Mac: `⌘+⇧+P`, Windows/Linux: `Ctrl+Shift+P`) and type in the following:

<Tabs>
  <Tab title="VS Code">
    <Frame>
      <img src="https://mintcdn.com/codeium/d8O4q6w3H2CjrirL/assets/import-vscode.png?fit=max&auto=format&n=d8O4q6w3H2CjrirL&q=85&s=ad0b864c3db087628f26d86241d23616" width="1452" height="404" data-path="assets/import-vscode.png" />
    </Frame>
  </Tab>

  <Tab title="Cursor">
    <Frame>
      <img src="https://mintcdn.com/codeium/bVGscI7v3lPUsThV/assets/windsurf/import-cursor.png?fit=max&auto=format&n=bVGscI7v3lPUsThV&q=85&s=a96df0b3235675e3713d0bf306170130" width="1454" height="272" data-path="assets/windsurf/import-cursor.png" />
    </Frame>
  </Tab>
</Tabs>

## Incompatible Extensions

There are a few extensions that are incompatible with Windsurf. These include other AI code complete extensions and proprietary extensions. You cannot install extensions through any marketplace on Windsurf.

## Custom App Icons (beta)

For paying users of Windsurf, you can choose between different Windsurf icons while it sits in your dock. Currently, this feature is only available for Mac OS, with other operating systems coming soon.

To change your app icon, simply click the profile/settings icon in the top right corner of the editor and select "Customize App Icon".

## Windsurf Next

Windsurf Next is prerelease version of Windsurf which users can choose to opt-in to access the newest features and capabilities as early as possible, even if the features are not fully polished. Features will typically be rolled out to Windsurf Next first, and then into the stable release shortly after.

You can opt-in to Windsurf Next simply by [downloading it here](https://windsurf.com/editor/download-next).

## Uninstall Windsurf

To uninstall Windsurf from your system, follow these steps:

<Steps>
  <Step title="Close Windsurf">
    Ensure that Windsurf is not currently running before proceeding with the uninstallation.
  </Step>

  <Step title="Delete the Windsurf application">
    <Tabs>
      <Tab title="Mac">
        Drag the Windsurf application from the Applications folder to the Trash.
      </Tab>

      <Tab title="Windows">
        The application is usually located in one of these folders:

        * `C:\Program Files\Windsurf`
        * `C:\Users\[YourUsername]\AppData\Local\Programs\Windsurf`

        Delete the Windsurf folder from the appropriate location.
      </Tab>

      <Tab title="Linux">
        Remove the Windsurf folder from the location where you installed it.
      </Tab>
    </Tabs>
  </Step>

  <Step title="Remove configuration files">
    <Tabs>
      <Tab title="Mac/Linux">
        Delete the Windsurf configuration folder:

        ```bash theme={null}
        rm -rf ~/.codeium/windsurf
        ```
      </Tab>

      <Tab title="Windows">
        Delete the Windsurf configuration folder:

        ```
        C:\Users\[YourUsername]\.codeium\windsurf
        ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="Additional cleanup">
    <ul>
      <li>If you installed Windsurf in PATH, remove it from your system's PATH environment variable.</li>
      <li>If you installed Windsurf using your system's package manager or control panel, you can also use that to uninstall it.</li>
      <li>Empty your Trash or Recycle Bin to complete the uninstallation.</li>
    </ul>
  </Step>
</Steps>
