@kyro-cms/core

Kyro CMS

---

What Kyro Gives You

Kyro turns a single TypeScript config into a full CMS backend for Astro, including:

• REST, GraphQL, tRPC, and WebSocket APIs from the same collection schema
• Local SQLite development plus production-ready PostgreSQL and MongoDB adapters
• Auto-generated admin UI with forms, media, auth, and drafts
• End-to-end type safety powered by Zod and TypeScript
• Plugin-friendly architecture for custom hooks, fields, and dashboard extensions

---

Quick Start

Create a new Kyro project

pnpm create kyro@latest my-project
cd my-project
pnpm install
pnpm dev

Open:

• http://localhost:4321 — public site
• http://localhost:4321/admin — admin dashboard

Add Kyro to an existing project

pnpm install @kyro-cms/core

// kyro.config.ts
import { defineConfig, createLocalAdapter } from "@kyro-cms/core";

export default defineConfig({
  name: "my-app",
  adapter: createLocalAdapter({ path: "./data.db" }),
  collections: {
    posts: {
      slug: "posts",
      label: "Posts",
      fields: [
        { name: "title", type: "text", required: true },
        { name: "slug", type: "text", required: true },
        { name: "content", type: "richtext" },
        { name: "published", type: "checkbox", defaultValue: false },
      ],
    },
  },
});

---

Why Kyro

Kyro is designed for Astro-first content applications:

• Fast dev setup: zero-config local SQLite support
• Unified API surface: one schema powers REST, GraphQL, tRPC, and WebSockets
• Production-ready: swap adapters without rewriting collections
• Admin experience: auto-generated UIs, auth, RBAC, and draft workflows

---

Core Concepts

Database adapters

Kyro uses a shared adapter layer so the same collection schema works across:

• SQLite — instant local development
• PostgreSQL — production SQL with Drizzle
• MongoDB — flexible document storage

API protocols

Use multiple protocols at once, depending on your app needs:

• REST for simple CRUD and integration compatibility
• GraphQL for nested queries and schema introspection
• tRPC for fully type-safe client-server calls
• WebSocket for real-time subscriptions and live updates

Astro-safe exports

Kyro preserves Astro compatibility with two entrypoints:

• @kyro-cms/core — server-only backend logic, adapters, auth, and APIs
• @kyro-cms/core/client — browser-safe client utilities, types, and UI helpers

Companion Packages

Kyro is designed as a modular ecosystem:

• kyro-connect — Universal, type-safe API client and codegen for any framework.
• kyro-rich-text-react — A headless React component for rendering Kyro's Tiptap JSON content.

---

Example usage

REST

GET /api/posts
GET /api/posts/:id
POST /api/posts
PATCH /api/posts/:id
DELETE /api/posts/:id

GraphQL

query {
  postsFind(where: {}, page: 1, limit: 10) {
    docs {
      id
      title
      slug
    }
    totalDocs
  }
}

tRPC

const response = await client.posts.find.query({ page: 1, limit: 10 });

---

Learn more

• docs/getting-started.md — setup and first app walkthrough
• docs/architecture.md — how Kyro works under the hood
• docs/api.md — API protocols and usage patterns
• docs/database.md — supported adapters and configuration

---

License

MIT