AI-Native Development

ObjectQL resides at the intersection of Data and Artificial Intelligence. It is designed to be "AI-Native" in two distinct ways:

1. For AI Agents: It serves as the perfect structured memory system (Long-term Memory) and tool interface for AI agents.
2. By AI Agents: Its metadata-driven, protocol-first architecture makes it incredibly easy for LLMs to write valid code for it.

Overview

🤖 AI-Powered CLI

Use the objectql ai command to generate complete applications from natural language, validate metadata, and get interactive assistance.

• CLI Usage Guide
• Interactive Mode
• One-Shot Generation
• Validation

Read CLI Guide →

📚 Programmatic API

Use the ObjectQL AI Agent in your Node.js applications to build custom development tools, web UIs, and automation.

• Basic Usage
• TypeScript Types
• Advanced Examples

Read API Docs →

✨ Generating Apps

Turn natural language into full backend systems instantly. Because ObjectQL uses declarative YAML/JSON, LLMs can "write" software by simply generating configuration files.

• Zero-Shot Generation
• Prompt Templates

Start Generating →

🏗️ Building AI Apps

Learn how to use ObjectQL as the data engine for your RAG (Retrieval-Augmented Generation) applications, semantic search, and AI agents.

• Semantic Search & RAG
• Vector Database Features
• Agent Tooling

Read Guide →

🤖 AI Coding Assistant

Learn how to configure GitHub Copilot, Cursor, or Windsurf to become an expert ObjectQL developer. We provide specialized System Prompts that teach the LLM our protocol.

• Standard System Prompt
• IDE Configuration

Get Prompts →

Quick Start

Command Line

# Set your API key
export OPENAI_API_KEY=sk-your-key
 
# Start interactive mode (easiest!)
objectql ai
 
# Or one-shot generation
objectql ai generate -d "A CRM system with customers and contacts"
 
# Validate metadata
objectql ai validate ./src

Programmatic

import { ObjectQLAgent } from '@objectql/core';
 
const agent = new ObjectQLAgent({
  apiKey: process.env.OPENAI_API_KEY!
});
 
// Generate application
const result = await agent.generateApp({
  description: 'Project management with tasks and milestones',
  type: 'complete'
});
 
// Validate metadata
const validation = await agent.validateMetadata({
  metadata: yamlContent,
  checkBusinessLogic: true
});

Key Features

✅ Natural Language to Code - Describe your app, get complete metadata
✅ TypeScript Generation - Actions and hooks with full implementations
✅ Test Generation - Automatic Jest tests for business logic
✅ AI-Powered Validation - Deep analysis beyond syntax checking
✅ Interactive Building - Conversational refinement through dialogue
✅ Programmatic API - Build custom dev tools and automation
✅ Multi-Language Support - Works with English and Chinese prompts
✅ Specification Compliance - Ensures generated code follows ObjectQL standards