README.md

.ai

This folder contains AI-assisted development tools for improving code quality and consistency.

How to use?

• Click on the "Use this template" button
• Create a .ai folder in your repository
• Move the content of this template into the .ai folder

Codex

Files

• codex.md: AI Codex - A repository of learnings and errors.
• learn.md: AI Learn - Protocol for updating the AI Codex.

Usage

1. Review the Codex: codex.md (silent load, no output)
2. Update the Codex: learn.md

Important Note

codex.md should be added to the context of every chat:

• For regular chats: Use the plus button at the top of the chat to add the file.
• For Composers: Add the file to a Project Composer so all Composers created in that project will automatically have the file.

Structure

The Codex is divided into two main sections:

1. Errors: Mistakes made and how to prevent them.
2. Learnings: Insights gained and their applications.

Each entry includes context, description, correction/application, and related entries.

Snippets

Snippets include code templates that AI can use to generate or refactor code. They help in writing shorter prompts for better results.

• create-snippet.md: Prompt for creating new snippets

Session

• start-session.md: Initiates a new AI session
• end-session.md: Concludes the current AI session

Session files create a "memory layer" for the AI across multiple interactions, enabling contextual awareness and adaptive assistance.

Key benefits:

• Maintains project context between sessions
• Reduces repetition of project details
• Provides consistent guidance aligned with project direction

Usage:

1. End a session: Use @end-session command
2. Start a new session: Use @start-session command

The AI will generate and read status files in status to maintain project continuity.

Blueprints

Blueprints are comprehensive guides for implementing specific technical architectures or project setups. They provide step-by-step instructions for installing, configuring, and integrating various technologies to create a functional foundation for your project.

• supabase-drizzle-actions.md: Backend architecture with Supabase, Drizzle ORM, and Server Actions
• flux-with-replicate.md: Image generation using Flux and Replicate

Libraries

• lib: Contains documentation examples for library usage

Plugins

v0

• v0.dev is a tool for generating React components from screenshots and chat. Currently, they don't have a Cursor plugin, so you can use v0 bridging prompt.
• v0.md: Guide for using v0.dev to generate component ideas and prompts

Rules of AI

Rules contains rules for default AI behavior and interaction. These rules are meant to be added to the global "Rules of AI" setting.

Contributing

This is an open-source template. Contributions are welcome! Please add a changelog entry with your contribution.

Note

This system is designed for AI consumption. Entries should prioritize precision and relevance over human readability