project-init

To initialize Windsurf project context, run the project-init workflow to scan your repository and automatically generate root AGENTS.md, ARCHITECTURE.md, and TESTING.md files. This establishes a clear project map and local guidance for Windsurf onboarding.

An AGENTS.md file outlines product purpose, service maps, mandatory rules, and repository structure for Windsurf projects. In a monorepo setup, scoped AGENTS.md files can be generated for significant directories to codify local conventions and workflows.

Yes, the generated ARCHITECTURE.md documents system design, runtime environments, and data flows. It works alongside TESTING.md to define testing strategy, providing comprehensive project documentation to accelerate AI agent integration.

Yes, you can use this workflow for multi-package or monorepo projects. It applies to repositories with multiple significant directories by producing a root project map and optional scoped AGENTS.md files for directories that warrant dedicated guidance.

The best way to document local conventions is generating scoped AGENTS.md files for significant directories. This approach codifies directory-specific workflows and rules, creating clear local guidance that accelerates onboarding and standardizes project setup.