What is a .windsurfrules file?

A .windsurfrules file is a text file committed to your repository root that Windsurf's AI agent loads on startup to guide its code edits, lint rules, file paths, and build/test commands.

How does this generator compare to Moxie Docs?

This tool helps you quickly draft a static .windsurfrules file. Moxie Docs connects to GitHub and replaces static rules files with a dynamic MCP server that serves live codebase context on demand without bloating your prompt token budget.

Can I use .windsurfrules with other AI coding assistants?

While .windsurfrules is Windsurf-specific, the core concepts of listing build commands and coding conventions map directly to standard instruction files like AGENTS.md.

FREE TOOL

.windsurfrules Generator

Structured Windsurf guidelines. Live preview. Clean Markdown export. Shareable links.

Draft the instructions file Windsurf's AI agent parses before editing your code. No signup required.

Learn how Moxie keeps rules living

Project nameSummary for WindsurfOne or two sentences: what the repo is and how Cursor should approach changes.Build commandsOne command per line - exported as a runnable code block.Test commandsOne command per line - what Cursor runs to verify changes.Code styleOne rule per line - each becomes a bullet.ConventionsOne rule per line - where things live and patterns Cursor should not guess.Repository layoutOne entry per line as “path - what it is”.PR & commit guidelinesOne rule per line - checks to run, title format, review expectations.Security notesOne rule per line - secrets handling and operations needing human review.

Live preview

Cursor Rules for Acme Payments API

TypeScript monorepo for billing, subscriptions, and Stripe webhooks. Prefer small, reviewable PRs with tests for payment and auth paths.

Build commands#

Shell

npm install
npm run build

Test commands#

Shell

npm run test
npm run lint

Code style#

Use TypeScript strict mode.
Prefer explicit return types on exported functions.
Keep modules focused - one domain per folder under src/lib/.

Conventions#

Stripe webhook handlers live in src/lib/billing/.
Never log secrets or full card numbers.
All billing mutations go through subscription-items.ts helpers.

Repository layout#

apps/web - Next.js dashboard and API routes
packages/shared - shared types
supabase/migrations - database schema

PR & commit guidelines#

Run the full test suite before opening a PR.
Keep PRs to one logical change; billing and auth changes need a test.
Title format: [area] Short imperative summary.

Security notes#

Do not commit .env files.
Webhook routes must verify Stripe signatures before dispatching events.

Windsurf Rules go stale - Moxie keeps instructions evergreen Export free above · connect a repo when you want Moxie to keep it accurate

See how Moxie keeps docs current Connect GitHub free

Windsurf-optimized structure

Runnable build/test command blocks, explicit conventions, file structure notes, and security directives specifically for the Windsurf AI agent.

Live preview

View the rendered .windsurfrules Markdown output in real-time as you fill out the fields.

Shareable drafts

The full editor state is persisted in the URL. Bookmark the page or share links directly with teammates.

Completely private

Runs entirely client-side. Your private codebase configurations and conventions never touch our servers.

What to include in .windsurfrules

Agent Instructions

Instruct the agent on how to approach refactors, write clean modules, and verify compilation status.

Repository Layout

Outline where components, styles, helper scripts, and tests belong so files are created in the right spots.

Build & Verify Scripts

List standard CLI commands for building, linting, and testing so the agent can self-repair broken changes.

Security Guardrails

Define explicit rules around secrets handling, API key exposure, and database mutations.

Built for the AI-agent era

Windsurf Rules go stale - Moxie keeps instructions evergreen

Draft and export your .windsurfrules here. Connect GitHub when you want Moxie to automatically detect doc gaps, catch drift, and serve fresh repo context via MCP.

See how Moxie keeps docs current Connect GitHub free

Export free above · connect a repo when you want Moxie to keep it accurate