Skip to main content

CUBBY.md File

The CUBBY.md file is a markdown document that provides context for AI coding assistants. Every Cubby app includes this file in the project root.

Purpose

When using Claude, ChatGPT, or other AI tools to build your app, they need to understand:
  • Cubby’s platform constraints
  • How to write API routes correctly
  • Database access patterns
  • What to avoid (auth libraries, hardcoded values)
CUBBY.md provides all this context in a format AI tools can reference.

Location

The file lives in your project root:

What’s Included

The default CUBBY.md created by cubby init covers:

Stack Information

Project Structure

CLI Commands

API Route Patterns

The file includes complete examples for:
  • Collection routes (GET all, POST create)
  • Dynamic routes with async params (Next.js 16 pattern)
  • Server components vs client components
  • Form handling with Server Actions

Platform Constraints

Authentication

Forbidden Patterns

Customizing CUBBY.md

You can extend CUBBY.md with app-specific context:

How AI Uses CUBBY.md

When you ask Claude or another AI to help with your app, the AI should:
  1. Read CUBBY.md at the start of the conversation
  2. Follow the patterns documented there
  3. Avoid forbidden patterns
  4. Use the correct API route signatures
If your AI isn’t following Cubby conventions, remind it to read CUBBY.md for context.

Full Template

View the complete default CUBBY.md in the GitHub repository or run cubby init to see it in your project.