Windsurf Setup
Configure Windsurf IDE with StarterApp context engineering.
StarterApp includes Windsurf IDE integration through custom rules in .windsurfrules
. The configuration directs Windsurf to read llms/CORE.md
for codebase patterns, enabling context-aware code generation with Cascade multi-file editing.
Automatic Context Loading
Windsurf reads .windsurfrules
automatically when opening the project. The file instructs Windsurf to load architectural patterns, security requirements, and template references from the /llms/
directory.
Installation
Download and install Windsurf IDE:
Visit codeium.com/windsurf ↗ and download the installer for the operating system
Run the installer. Windsurf is built as a standalone AI-native IDE with VS Code compatibility.
Launch Windsurf and complete the onboarding flow
Sign in or create a Codeium account when prompted
Open the StarterApp project folder. The .windsurfrules
configuration loads automatically.
VS Code Migration
Import existing VS Code configuration during onboarding:
Context Configuration
Custom Rules
The .windsurfrules
file provides repository-specific context:
# Core AI Agent Rules
[CRITICAL] Read all lines of `llms/CORE.md` and execute its instructions.
Windsurf reads this file automatically and loads codebase patterns from llms/CORE.md
. The instruction directs Windsurf to:
AI Features
Cascade Multi-File Editing
Cascade enables complex feature implementation across multiple files simultaneously:
Open Cascade panel on the right side of the IDE (or press Cmd+Shift+C
/ Ctrl+Shift+C
)
Describe the feature:
Create user profile feature with:
- Protected page in apps/dashboard/app/(dashboard)/profile
- Convex mutations in convex/profile.ts
- Update schema in convex/schema.ts
Review proposed file changes in the Cascade panel
Accept or modify suggestions. Cascade creates all files with consistent patterns.
Pro Tip
Cascade references patterns from .windsurfrules
automatically. Generated code follows StarterApp conventions without explicit template mentions.
AI Chat
Open AI chat with Cmd+I
or Ctrl+I
:
Model Configuration
Configure AI model preferences:
Command Execution
Execute StarterApp workflows through natural language in Cascade or chat:
Keyboard Shortcuts
Essential shortcuts for Windsurf:
Recommended Extensions
Install extensions for optimal StarterApp development:
Pro Tip
Windsurf maintains compatibility with VS Code extensions. Most extensions work without modification.
Validation Workflow
Verify generated code meets quality standards:
# Type safety
pnpm typecheck
# Code quality
pnpm lint
# Test execution
pnpm test
# Build verification
pnpm build
# Run all checks
pnpm validate
The pnpm validate
command runs all checks sequentially and reports failures.
Best Practices
Next Steps
After Windsurf IDE setup:
AI Workflow Overview
Learn AI-assisted development patterns using templates, commands, and context engineering.
Template System
Production-ready code patterns for authentication, billing, and data operations.
Environment Setup
Configure service credentials and environment variables for development.