LLM Notice: This documentation site supports content negotiation for AI agents. Request any page with Accept: text/markdown or Accept: text/plain header to receive Markdown instead of HTML. Alternatively, append ?format=md to any URL. All markdown files are available at /md/ prefix paths. For all content in one file, visit /llms-full.txt
Skip to main content

Use Flow knowledge base in Cursor

Cursor is an AI code editor that makes it easy to write code while you build Flow apps. This section provides comprehensive guidance on how to set up and use Cursor with Flow's extensive documentation ecosystem to enhance your development experience.

To get the most out of Cursor for Flow development, you'll need to understand three key components:

  1. Flow Data Sources - The comprehensive knowledge base that powers AI assistance.
  2. Documentation Indexing - How to make Flow documentation available within Cursor.
  3. Cadence Rules - Persistent AI context that provides specialized Flow development guidance.

Flow Data Sources​

Learn about Flow's comprehensive, auto-generated documentation repository that serves as the foundation for AI-assisted development. This resource contains the most current information about Flow, Cadence, and the broader ecosystem, specifically formatted for optimal AI integration.

The Flow Data Sources guide covers:

  • What Flow Data Sources contains and how it's organized.
  • Different file formats available for various use cases.
  • Integration strategies with AI tools.
  • Best practices to leverage this knowledge base.

Indexing Flow Documentation in Cursor​

Follow the step-by-step process for how to set up Flow documentation within Cursor's AI system. This detailed guide walks you through how to index multiple documentation sources to create a comprehensive Flow development environment.

The documentation covers how to:

  • Add Flow developer documentation to Cursor.
  • Integrate Cadence language documentation.
  • Include Flow Data Sources for comprehensive coverage.
  • Troubleshoot common indexing issues.
  • Apply best pratices for indexed documentation.

Cadence Rules​

Learn how to use Cursor Rules to enhance AI assistance for Cadence and Flow development with persistent context and automated workflows. This comprehensive guide demonstrates how to create specialized rules that transform your AI assistant into a Flow development expert with continuous knowledge of syntax patterns, NFT standards, and project workflows.

The Cadence Rules guide covers:

  • Cursor Rule basics and how they provide persistent AI context.
  • Five specialized rules for Flow development: NFT standards, syntax patterns, development workflows, project configuration, and user preferences.
  • How to create custom rules for your specific Flow development needs.
  • Best practices for rule organization and team collaboration.
  • Integration with current Flow development tools and documentation

Get started​

  1. Start with Flow Data Sources: Understand what documentation is available and how it can enhance your development workflow.
  2. Follow the Indexing Guide: Set up your Cursor environment with comprehensive Flow documentation.
  3. Configure Cadence Rules: Implement persistent AI context for consistent Flow development assistance.
  4. Practice with Examples: Use the indexed documentation and rules to build Flow applications with enhanced AI assistance.

Best practices for cursor + flow​

  • Use Specific References: Target @Flow, @Cadence, or @Flow Data Sources based on your needs.
  • Leverage Cursor Rules: Apply @cadence-nft-standards, @cadence-syntax-patterns, or other specialized rules for consistent guidance.
  • Combine Sources: Leverage multiple documentation sources and rules for comprehensive assistance.
  • Verify AI Output: Cross-reference generated code with official documentation.
  • Stay Updated: Refresh your documentation indexes and rules periodically for current information.

This integrated approach combines comprehensive documentation indexing with persistent AI context through Cursor Rules. This provides you with consistent, accurate, and specialized assistance throughout your Flow development process.

Rate this page