Welcome to Windsurf - Windsurf Docs
Welcome to Windsurf - Windsurf DocsSkip to main contentWindsurf Docs home pageEnglishSearch...⌘KAsk AIFeature RequestDownloadDownloadSearch...NavigationGetting StartedWelcome to WindsurfWindsurfWindsurf PluginsWindsurf ReviewsDiscord CommunityWindsurf BlogSupportEditorGetting StartedSet UpRecommended ExtensionsModelsTabCommandCode LensesTerminalBrowser PreviewsAI Commit MessagesDeepWikiCodemaps (Beta)Vibe and ReplaceAdvancedCascadeOverviewApp DeploysWeb and Docs SearchMemories & RulesSkillsAGENTS.mdWorkflowsWorktreesModel Context Protocol (MCP)Cascade HooksAccountsUsageAnalyticsTeams & EnterpriseContext AwarenessOverviewFast ContextWindsurf IgnoreTroubleshootingCommon IssuesProxy ConfigurationGathering LogsSecurityReportingOn this pageSet UpOnboarding1. Select setup flow2. Choose editor theme3. Sign up / Log inHaving Trouble?4. Let’s Surf!Update WindsurfThings to TryForgot to Import VS Code Configurations?Incompatible ExtensionsCustom App Icons (beta)Windsurf NextUninstall WindsurfGetting StartedWelcome to WindsurfDownload 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.CascadeYour agentic chatbot that can collaborate with you like never before.UsageCredits and usage.TerminalAn upgraded Terminal experience.MCPMCP servers extend the agent’s capabilities.MemoriesMemories and rules help customize behavior.Context AwarenessInstantly understands your codebase.AdvancedAdvanced configuration options.WorkflowsAutomate repetitive trajectories.App DeploysDeploy applications in one click. See what’s new with Windsurf in our changelog! Set UpTo 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 if you’re looking for how to update Windsurf. Mac Windows Ubuntu Other Linux distributionsMinimum OS Version: OS X YosemiteDownload for MacMinimum OS Version: Windows 10Download for WindowsMinimum OS Version: >= 20.04 (or glibc >= 2.31, glibcxx >= 3.4.26)Download for UbuntuMinimum OS Version: glibc >= 2.28, glibcxx >= 3.4.25Download for LinuxOnboardingOnce 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.1. Select setup flowIf 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. Start fresh Import from VS Code Import from CursorChoose your keybindings here, either default VS Code bindings or Vim bindings.You can migrate your settings, extensions, or both here.You can migrate your settings, extensions, or both here.2. Choose editor themeChoose 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.3. Sign up / Log inTo use Windsurf, you need to use your Windsurf account or create one if you don’t have one. Signing up is completely free!Once you’ve authenticated correctly, you should see this page. Hit “Open Windsurf” and you’re good to go!Having Trouble?If you’re having trouble with this authentication flow, you can also log in and manually provide Windsurf with an authentication code. 1. Select "Having Trouble?" 2. Enter Authentication CodeClick the “Copy link” button to copy an authentication link to your clipboard and enter this link into your browser.Copy the authentication code displayed in the link and enter it into Windsurf.4. Let’s Surf!Recommended PluginsExplore some of our recommended plugins to get the most out of Windsurf!Update WindsurfTo update Windsurf, you can click on the “Restart to Update ->” button in the top right corner of the menu bar.If you are not seeing this button, you can:Click on your Profile icon dropdown > Check for UpdatesIn the Command Palette (Cmd/Ctrl+Shift+P) > “Check for Updates”Things to TryNow that you’ve successfully opened Windsurf, let’s try out some of the features! These are all conveniently accessible from the starting page. :)Write with CascadeOn 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.Generate a project with CascadeYou can create brand new projects with Cascade! Click the “New Project” button to get started.Open Folder / Connect to Remote ServerYou can open a folder or connect to a remote server via SSH or a local dev containe...
Welcome to Windsurf - Windsurf DocsSkip to main contentWindsurf Docs home pageEnglishSearch...⌘KAsk AIFeature RequestDownloadDownloadSearch...NavigationGetting StartedWelcome to WindsurfWindsurfWindsurf PluginsWindsurf ReviewsDiscord CommunityWindsurf BlogSupportEditorGetting StartedSet UpRecommended ExtensionsModelsTabCommandCode LensesTerminalBrowser PreviewsAI Commit MessagesDeepWikiCodemaps (Beta)Vibe and ReplaceAdvancedCascadeOverviewApp DeploysWeb and Docs SearchMemories & RulesSkillsAGENTS.mdWorkflowsWorktreesModel Context Protocol (MCP)Cascade HooksAccountsUsageAnalyticsTeams & EnterpriseContext AwarenessOverviewFast ContextWindsurf IgnoreTroubleshootingCommon IssuesProxy ConfigurationGathering LogsSecurityReportingOn this pageSet UpOnboarding1. Select setup flow2. Choose editor theme3. Sign up / Log inHaving Trouble?4. Let’s Surf!Update WindsurfThings to TryForgot to Import VS Code Configurations?Incompatible ExtensionsCustom App Icons (beta)Windsurf NextUninstall WindsurfGetting StartedWelcome to WindsurfDownload 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.CascadeYour agentic chatbot that can collaborate with you like never before.UsageCredits and usage.TerminalAn upgraded Terminal experience.MCPMCP servers extend the agent’s capabilities.MemoriesMemories and rules help customize behavior.Context AwarenessInstantly understands your codebase.AdvancedAdvanced configuration options.WorkflowsAutomate repetitive trajectories.App DeploysDeploy applications in one click. See what’s new with Windsurf in our changelog! Set UpTo 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 if you’re looking for how to update Windsurf. Mac Windows Ubuntu Other Linux distributionsMinimum OS Version: OS X YosemiteDownload for MacMinimum OS Version: Windows 10Download for WindowsMinimum OS Version: >= 20.04 (or glibc >= 2.31, glibcxx >= 3.4.26)Download for UbuntuMinimum OS Version: glibc >= 2.28, glibcxx >= 3.4.25Download for LinuxOnboardingOnce 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.1. Select setup flowIf 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. Start fresh Import from VS Code Import from CursorChoose your keybindings here, either default VS Code bindings or Vim bindings.You can migrate your settings, extensions, or both here.You can migrate your settings, extensions, or both here.2. Choose editor themeChoose 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.3. Sign up / Log inTo use Windsurf, you need to use your Windsurf account or create one if you don’t have one. Signing up is completely free!Once you’ve authenticated correctly, you should see this page. Hit “Open Windsurf” and you’re good to go!Having Trouble?If you’re having trouble with this authentication flow, you can also log in and manually provide Windsurf with an authentication code. 1. Select "Having Trouble?" 2. Enter Authentication CodeClick the “Copy link” button to copy an authentication link to your clipboard and enter this link into your browser.Copy the authentication code displayed in the link and enter it into Windsurf.4. Let’s Surf!Recommended PluginsExplore some of our recommended plugins to get the most out of Windsurf!Update WindsurfTo update Windsurf, you can click on the “Restart to Update ->” button in the top right corner of the menu bar.If you are not seeing this button, you can:Click on your Profile icon dropdown > Check for UpdatesIn the Command Palette (Cmd/Ctrl+Shift+P) > “Check for Updates”Things to TryNow that you’ve successfully opened Windsurf, let’s try out some of the features! These are all conveniently accessible from the starting page. :)Write with CascadeOn 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.Generate a project with CascadeYou can create brand new projects with Cascade! Click the “New Project” button to get started.Open Folder / Connect to Remote ServerYou can open a folder or connect to a remote server via SSH or a local dev containe...