LLM Context File.

Make OrkaJS discoverable by AI assistants. Our llm.txt file helps LLMs understand your framework instantly.

What is llm.txt?

llm.txt is a standardized format that helps AI assistants (like ChatGPT, Claude, Gemini) understand your framework's capabilities, API, and best practices. When developers ask these AI tools about OrkaJS, they can reference this file to provide accurate, up-to-date information.

AI-First Documentation

Better AI Responses

Framework Discoverability

Always Up-to-Date

Why It Matters for Developers

Faster Onboarding

Developers can ask AI assistants about OrkaJS and get accurate code examples instantly.

Better Code Generation

AI tools can generate OrkaJS code that follows best practices and uses the correct API.

Community Growth

Makes OrkaJS more discoverable when developers search for AI framework solutions.

How AI Assistants Use It

Example Interaction

👤 Developer:

"How do I create a RAG system with OrkaJS?"

🤖 AI Assistant (with llm.txt):

"Here's how to create a RAG system with OrkaJS. First, install the required packages..."

import { createOrka } from '@orka-js/core';
import { OpenAIAdapter } from '@orka-js/openai';
import { MemoryVectorAdapter } from '@orka-js/memory';
 
const orka = createOrka({
  llm: new OpenAIAdapter({ apiKey: process.env.OPENAI_API_KEY! }),
  vectorDB: new MemoryVectorAdapter(),
});
 
await orka.knowledge.create({
  name: 'docs',
  source: ['Your documentation...'],
});
 
const result = await orka.ask({
  knowledge: 'docs',
  question: 'How does it work?',
});

What's Included in Our llm.txt

All 21+ packages with descriptions

Complete API reference

Code examples for every feature

Best practices & patterns

Security guidelines

Error handling strategies

Performance optimization tips

TypeScript configuration

Access the File

The llm.txt file is publicly accessible at:

https://orkajs.com/llm.txtView File

AI assistants can reference this URL to get comprehensive information about OrkaJS.

💡 Pro Tip for Developers

When asking AI assistants about OrkaJS, you can mention: "Please reference the OrkaJS llm.txt file at orkajs.com/llm.txt" to ensure you get the most accurate and up-to-date information.

Standard Compliance

Our llm.txt follows the emerging standard for AI-readable documentation. This format is being adopted by major frameworks and libraries to improve AI assistant accuracy.

📋 Format Features

• Markdown-based for readability
• Structured sections
• Code examples with syntax highlighting
• Version information

🔄 Maintenance

• Updated with every release
• Synchronized with documentation
• Includes latest features
• Reflects current best practices

Ready to Build?

Now that you know how AI assistants can help you with OrkaJS, start building your first AI application.

Quick Start