LLMS.txt

Callaloo provides machine-readable documentation to help Large Language Models (LLMs) and AI agents (like Cursor, Windsurf, or Gemini) generate better code using our components and design system.

What is llms.txt?

The llms.txt file is an emerging standard for serving documentation in a format that AI tools can easily parse. It contains core rules, component indices, and links to the full documentation.

Raw Files

We provide two versions of our AI documentation:

• llms.txt: A token-efficient summary containing core rules and links to full documentation. Best for agents with smaller context windows or those that can browse the web.
• llms-full.txt: A comprehensive file containing the full text of all documentation pages. Best for high-context agents that need all information in a single request.

Usage

For AI-Powered IDEs (Cursor, Windsurf, etc.)

To ensure your AI assistant has the most up-to-date information about Callaloo, you can add our documentation URL to your tool's settings:

1. Open your IDE settings.
2. Navigate to the Features > Docs or Rules section.
3. Add a new documentation entry with the URL: https://callaloo.dev/llms.txt

For General Purpose LLMs (Gemini, ChatGPT, Claude)

If you are working in a chat environment, you can provide the following prompt to give the AI context about Callaloo:

Prompt

"Please read the Callaloo documentation at https://callaloo.dev/llms.txt before generating any Vue 3 components or logic. Adhere strictly to the Enums and Component prefixes defined there."

Key Rules for AI

Our documentation explicitly instructs AI agents to:

• Always use Enums: Prop values for colors, sizes, and variants should use imports from @codeandfunction/callaloo.
• Wrap in Providers: All Callaloo components must be descendants of CLThemeProvider.
• Use CL Prefix: All components are prefixed with CL (e.g., <CLButton />).
• Support No-Build: Adhere to specific global registration patterns when a CDN/No-build environment is detected.