Codeium

docs.codeium.com

AI & Machine Learning

Codeium offers best in class AI code completion, search, and chat — all for free.

llms.txt

Windsurf Docs

Docs

Autocomplete Overview: AI-powered code autocomplete with single-line and multi-line suggestions, keyboard shortcuts, and customizable speed settings.
Autocomplete Tips: Tips for getting the most out of Windsurf Autocomplete including inline comments, Fill In The Middle (FIM), and snooze functionality.
Prompt Engineering: Best practices for crafting effective prompts to get high-quality code from Windsurf, including clear objectives, context, and constraints.
Common Use Cases: Common use cases for Windsurf including code generation, unit test generation, code documentation, API integration, and code refactoring.
Chat Models: Available AI models for Windsurf Chat including Base Model, Windsurf Premier, GPT-4o, and Claude 3.5 Sonnet with different access levels.
Chat Overview: Chat with your codebase using Windsurf Chat in VS Code and JetBrains. Use @-mentions, persistent context, pinned files, and inline citations.
Command Overview: Use Windsurf Command for AI-powered inline code edits in VS Code and JetBrains. Generate or edit code with natural language prompts using Cmd/Ctrl+I.
Refactors, Docstrings, and More: Use Command-powered features like code lenses for refactoring, docstring generation, and Smart Paste for cross-language code translation.
Command: Use Windsurf Command (Cmd/Ctrl+I) for inline code generation and edits with natural language. No premium credits required.
Code Lenses: Use Windsurf code lenses for quick Explain, Refactor, and Docstring operations on functions and classes directly in the editor.
Fast Context: Fast Context is a specialized subagent that retrieves relevant code from your codebase up to 20x faster using SWE-grep models for rapid code retrieval.
Context Awareness Overview: Windsurf's RAG-based context engine indexes your codebase for intelligent suggestions. Learn about context pinning, knowledge base, and M-Query retrieval.
Remote Indexing: Index remote repositories from GitHub, GitLab, and BitBucket for enterprise teams without storing code locally.
Windsurf Ignore: Configure which files and directories Windsurf should ignore during indexing using .codeiumignore files with gitignore-style syntax.
Context Awareness for Windsurf: Windsurf's RAG-based context engine indexes your codebase for intelligent code suggestions. Supports remote repositories for Teams and Enterprise.
Analytics: View individual user analytics, team analytics, usage patterns, and metrics for your Windsurf usage including code completion stats and AI-written code percentage.
Analytics API: Enterprise analytics API for querying Windsurf usage data including autocomplete, chat, command, and Cascade metrics.
API Reference: Enterprise API for querying Windsurf usage data and managing configurations with service key authentication.
Get Cascade Analytics: Query Cascade-specific usage metrics including lines suggested/accepted, model usage, credit consumption, and tool usage statistics.
Custom Analytics Query: Flexible analytics querying with custom selections, filters, and aggregations for autocomplete, chat, command, and PCW data.
Error Handling: Common error messages and debugging tips for the Analytics API including authentication, query structure, and rate limiting errors.
Get Team Credit Balance: Retrieve the current credit balance for your team, including prompt credits per seat, add-on credits, and billing cycle information.
Get Usage Configuration: Retrieve per-user add-on credit cap configuration, queried by team, group, or individual user scope for enterprise billing management.
Set Usage Configuration: Set or clear per-user add-on credit caps, with the ability to apply them across a team, group, or individual user for enterprise billing management.
Get User Page Analytics: Retrieve user activity statistics including names, emails, last activity times, and active days from the teams page.
Role Based Access & Management: Configure RBAC permissions, create custom roles, and manage user access for Windsurf Enterprise plans.
Setting up SSO & SCIM: Configure Single Sign-On (SSO) and SCIM provisioning for your organization using Google Workspace, Microsoft Azure AD, Okta, or other SAML identity providers.
Getting started with Teams and Enterprise: Set up Teams and Enterprise plans with team management, SSO, analytics, user groups, and priority support for your organization.
Plans and Credit Usage: Understand Windsurf pricing plans, prompt credits, usage tracking, automatic refills, and how to upgrade from Free to Pro, Teams, or Enterprise.
Cascade Overview: Cascade brings agentic AI coding to JetBrains with Write/Chat modes, voice input, tool access, turbo mode, and real-time collaboration.
Model Context Protocol (MCP): Configure MCP servers to extend Cascade with custom tools and services using stdio, HTTP, or SSE transports with admin controls for Teams and Enterprise.
Memories & Rules: Configure Cascade memories and rules to persist context across conversations with global rules, workspace rules, and system-level rules for enterprise.
Cascade Models: Available AI models in Cascade including SWE-1.6, SWE-1.5, SWE-1, Claude, GPT, and bring-your-own-key (BYOK) options with credit costs.
Web and Docs Search: Enable Cascade to search the web and read documentation pages in real-time using @web and @docs mentions for up-to-date context.
Workflows: Create reusable Cascade workflows as markdown files to automate repetitive tasks like deployments, PR reviews, and code formatting with slash commands.
IDE Compatibility: Supported IDEs and version requirements for Windsurf Plugins including VS Code, JetBrains, Visual Studio, NeoVim, Vim, Emacs, Xcode, Sublime Text, and Eclipse.
Welcome to Windsurf Plugins: Install and set up Windsurf Plugins for JetBrains, VS Code, Visual Studio, Vim, NeoVim, Jupyter, Chrome, and other IDEs with AI-powered coding assistance.
Guide for Admins: Enterprise admin guide for deploying Windsurf at scale. Configure SSO, SCIM, RBAC, analytics, and team management for large organizations.
Reporting Security Concerns: Report security vulnerabilities to Windsurf securely via email with GPG encryption. Learn about our coordinated disclosure policy and safe harbor.
FedRAMP Security Admin Guide: Windsurf FedRAMP Security Admin Guide for securely setting up, configuring, operating, and decommissioning top-level administrative accounts. Includes role definitions, account lifecycle procedures, and a reference table of all admin-controlled security settings.
Windsurf Tab: Windsurf Tab provides AI-powered code suggestions with Tab to Jump, Tab to Import, and inline suggestions, powered by our custom model.
General Issues: Common Windsurf plugin issues including subscription problems, cancellation, telemetry settings, account deletion, and chat panel troubleshooting.
Eclipse Troubleshooting: Troubleshoot Eclipse plugin issues including startup problems, empty chat screen, WebView2, and certificate errors with Java keystore solutions.
JetBrains Troubleshooting: Troubleshoot JetBrains plugin issues including JCEF errors, certificate problems, custom workspaces, and extension diagnostics.
Proxy Configuration for Windsurf in JetBrains IDEs: Configure HTTP/HTTPS proxy settings for Windsurf plugin in JetBrains IDEs including remote development and Gateway environments.
Visual Studio Troubleshooting: Troubleshoot Visual Studio plugin issues including IntelliCode conflicts, Tab key bindings, and marketplace visibility problems.
Visual Studio Code (VSCode) Troubleshooting: Troubleshoot VS Code extension issues including proxy settings, certificate errors, API server configuration, and chat response problems.
Gathering Plugin Logs: How to collect diagnostic logs from JetBrains, VS Code, Eclipse, Visual Studio, and NeoVim for troubleshooting Windsurf plugin issues.
Common Windsurf Issues: Troubleshoot common Windsurf Editor issues including rate limiting, MacOS security warnings, Windows updates, Linux crashes, and terminal problems.
Gathering Windsurf Logs: How to download diagnostic logs from Windsurf Editor using the Command Palette or Cascade panel for troubleshooting support.
Language Server Fails with 'No Space Left on Device' on Linux: Resolve Linux language server startup failures caused by exhausted inotify watch/instance limits (ENOSPC). Includes symptoms, diagnosis commands, and sysctl fixes.
Proxy Configuration in Windsurf Editor: Configure HTTP/HTTPS proxy settings for Windsurf Editor in corporate networks. Includes auto-detect, manual configuration, and SSH remote proxy setup.
TLS / SSL Inspection Issues in Windsurf: Configure enterprise environments where SSL inspection (e.g., Zscaler) causes TLS certificate validation or protocol negotiation failures. Includes how to capture Console errors and what to request from IT/security.
WSL Known Issues: Troubleshoot known Windsurf issues when running in Windows Subsystem for Linux (WSL), including slow performance from Plan 9 (9P) filesystem saturation and connection failures caused by VPN or zero-trust network software.
Analytics: View individual user analytics, team analytics, usage patterns, and metrics for your Windsurf usage including code completion stats and AI-written code percentage.
Analytics API: Enterprise analytics API for querying Windsurf usage data including autocomplete, chat, command, and Cascade metrics.
API Reference: Enterprise API for querying Windsurf usage data and managing configurations with service key authentication.
Get Cascade Analytics: Query Cascade-specific usage metrics including lines suggested/accepted, model usage, credit consumption, and tool usage statistics.
Custom Analytics Query: Flexible analytics querying with custom selections, filters, and aggregations for autocomplete, chat, command, and PCW data.
Error Handling: Common error messages and debugging tips for the Analytics API including authentication, query structure, and rate limiting errors.
Get Team Credit Balance: Retrieve the current credit balance for your team, including prompt credits per seat, add-on credits, and billing cycle information.
Get Usage Configuration: Retrieve per-user add-on credit cap configuration, queried by team, group, or individual user scope for enterprise billing management.
Set Usage Configuration: Set or clear per-user add-on credit caps, with the ability to apply them across a team, group, or individual user for enterprise billing management.
Get User Page Analytics: Retrieve user activity statistics including names, emails, last activity times, active days, and prompt credits used from the teams page.
Domain Verification: Verify your organization's domain ownership with DNS TXT records to enable SSO, user management, and automatic team invitations in Windsurf.
Quota-Based Usage: Learn how Windsurf's quota-based usage system works, including daily and weekly allowances, extra usage, and migration details for existing subscribers.
Role Based Access & Management: Configure RBAC permissions, create custom roles, and manage user access for Windsurf Enterprise plans.
Setting up SSO & SCIM: Configure Single Sign-On (SSO) and SCIM provisioning for your organization using Google Workspace, Microsoft Azure AD, Okta, or other SAML identity providers.
Getting started with Teams and Enterprise: Set up Windsurf Teams and Enterprise plans with team management, SSO, analytics, user groups, and priority support for your organization.
Plans and Usage: Understand Windsurf pricing plans, usage tracking, and how to upgrade from Free to Pro, Teams, or Enterprise.
Adaptive: Adaptive is Cognition's intelligent model router that automatically selects the best AI model for each task.
Advanced Configuration: Advanced Windsurf configurations including SSH support, Dev Containers, WSL, extension marketplace settings, diff zones, and gitignore access for Cascade.
Agent Command Center: Manage all of your Windsurf agents — local and cloud — from a single Kanban-style view inside Windsurf.
AI Commit Messages: Generate meaningful git commit messages automatically with AI by analyzing your code changes with a single click in Windsurf.
AGENTS.md: Create AGENTS.md files to provide directory-scoped instructions to Cascade. Instructions automatically apply based on file location in your project.
App Deploys: Deploy web applications directly from Windsurf to Netlify with public URLs, automatic builds, and project claiming for Next.js, React, Vue, and Svelte.
Arena Mode: Run multiple Cascade instances in parallel using arena mode to explore different approaches simultaneously.
Cascade Overview: Cascade is Windsurf's agentic AI assistant with Code/Chat modes, tool calling, voice input, checkpoints, real-time awareness, and linter integration.
Cascade Hooks: Execute custom shell commands at key points in Cascade's workflow for logging, security controls, validation, and enterprise governance with pre and post hooks.
Model Context Protocol (MCP): Integrate MCP servers with Cascade to access custom tools like GitHub, databases, and APIs. Configure stdio, HTTP, and SSE transports with admin controls for Teams.
Memories & Rules: Persist context across Cascade conversations with auto-generated memories and user-defined rules at global, workspace, and system levels for enterprise teams.
Cascade Modes: Cascade offers multiple distinct modes, each optimized for different types of tasks.
Skills: Skills help Cascade handle complex, multi-step tasks.
Web and Docs Search: Search the web and documentation directly from Cascade using @web and @docs mentions, URL parsing, and real-time context from web pages.
Workflows: Automate repetitive tasks in Cascade with reusable workflows defined as markdown files. Create PR review, deployment, testing, and code formatting workflows.
Worktrees: Automatically set up git worktrees for parallel Cascade tasks
Codemaps: Create shareable hierarchical maps of your codebase to visualize code execution flow and component relationships. Navigate and share with teammates.
C#, .NET, and CPP: Setup guide for C#, .NET Core, .NET Framework (Mono), and C++ development in Windsurf using open-source tooling like OmniSharp, clangd, and LLDB.
DeepWiki: Get AI-powered explanations of code symbols with DeepWiki. Hover over functions, variables, and classes to understand unfamiliar code in your codebase.
Devin in Windsurf: Delegate work to Devin, an autonomous cloud agent, directly from Windsurf — and review its PRs without leaving your editor.
Devin Local Agent: Use the same agent harness as Devin CLI directly inside Windsurf.
Enterprise Policies: Manage Windsurf settings centrally with enterprise policies. Configure extension allowlists, update modes, and other settings on Windows, macOS, and Linux using group policies, configuration profiles, and JSON policy files.
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.
Guide for Admins: Enterprise admin guide for deploying Windsurf at scale. Configure SSO, SCIM, RBAC, analytics, and team management for large organizations.
AI Models: Available AI models in Windsurf Cascade including SWE-1.6, SWE-1.5, Claude, GPT, and BYOK options. Compare model capabilities, credit costs, and performance.
Windsurf Previews: Preview your web app locally in Windsurf IDE or browser with element selection, error capture, and direct integration with Cascade for rapid iteration.
Quick Review: Quick Review runs an agentic code review on your local changes using AI models.
Recommended Extensions: Popular Open VSX extensions for Windsurf including Python, Java, C#, GitLens, and more. Replicate familiar IDE experiences from VS Code, Eclipse, or Visual Studio.
Spaces: Spaces group all of the agent sessions, PRs, files, and context for a task or project into a single view in the Agent Command Center.
Terminal: Use Windsurf's enhanced terminal with Command mode, Cascade integration, Turbo mode for auto-execution, and allow/deny lists for command control.
Vibe and Replace: AI-powered find and replace that applies natural language prompts to each match. Use Smart mode for careful changes or Fast mode for quick transformations.