# ledric

> A self-hosted, MCP-native CMS. Humans edit through an admin GUI or a click-to-edit overlay on the live site; agents edit through MCP — twenty structured tools that mirror the admin API; your site reads through a thin HTTP API or typed SDKs (TypeScript and PHP). One Node process, one SQLite file (or external Postgres / MySQL), one versioned content store backing all three surfaces.

ledric is open source (Apache 2.0) and shipped on npm as `ledric`. The repo lives at https://github.com/getledric/ledric.

## Getting started

- [Quickstart](https://getledric.com/docs/quickstart/): Get ledric running in two minutes with one Node process and one SQLite file.
- [Concepts](https://getledric.com/docs/concepts/): The mental model: types, entries, ids/slugs/refs, versions, structural vs inline references, assets, locales, environments, and the wire format.
- [Build with an agent](https://getledric.com/docs/build-with-an-agent/): End-to-end walkthrough: ask Claude to set up a schema, seed content, build an Astro site, wire up inline editing.
- [Build with an agent — PHP](https://getledric.com/docs/build-with-an-agent-php/): Same end-to-end walkthrough as Build with an agent, but with a vanilla PHP consumer using Ledric\\LedricClient.

## Guides

- [Inline editor](https://getledric.com/docs/inline-editor/): <script> install, data-ledric-ref / data-ledric-field attributes, refAttrs() helpers, auth, behaviour.
- [Agent recipes](https://getledric.com/docs/agent-recipes/): Example prompts: project setup, drafting, schema evolution, bulk ops, refactoring, localization.
- [Localization](https://getledric.com/docs/localization/): Per-type locales, localized:true fields, _locale sidecar, fallback chains, locale-specific slugs.
- [Why ledric](https://getledric.com/docs/why/): Honest comparison vs Contentful, Sanity, Payload, Strapi, Directus — and when ledric is the wrong choice.
- [FAQ](https://getledric.com/docs/faq/): The questions that come up most: production-readiness, SQLite limits, hosting, the agent angle, migration, backups.
- [Roadmap](https://getledric.com/docs/roadmap/): What's stable, in progress, planned, and explicitly out of scope. No timelines — just clear lines.

## Reference

- [Schema](https://getledric.com/docs/schema/): Field types catalogue, defineType() examples, options, validation, schema evolution.
- [MCP tools](https://getledric.com/docs/mcp-tools/): The 20-tool surface for agents — reads, writes, schema, assets, tags. Same shape as POST /rpc.
- [Remote MCP](https://getledric.com/docs/remote-mcp/): Two modes: local (--http-mcp, share one daemon across local clients) and public (--public-mcp, OAuth provider for claude.ai custom connectors).
- [HTTP API](https://getledric.com/docs/http-api/): REST routes for reads, multipart uploads, generic POST /rpc, image transforms, slug redirects, error codes.
- [SDKs](https://getledric.com/docs/sdks/): @ledric/sdk (TypeScript) and Ledric\\LedricClient (PHP, Composer ledric/sdk) — same wire format.
- [Assets](https://getledric.com/docs/assets/): id / ref_key split, db vs local backends, uploads, image transforms, in-place bytes replacement, transforms cache.
- [Auth](https://getledric.com/docs/auth/): Reader and admin keys, key minting, header formats, closed-reads mode, rotation.
- [Architecture](https://getledric.com/docs/architecture/): What's running when ledric boots: the packages, the storage adapters, the asset pipeline, the inline editor, process lifecycle.

## Operations

- [Deployment](https://getledric.com/docs/deployment/): Production shape: CDN in front of /assets, reverse proxy + TLS, env-supplied keys, backups, Postgres / MySQL.

## Source

- [GitHub repository](https://github.com/getledric/ledric): The full source, issue tracker, and release notes.
- [npm package](https://www.npmjs.com/package/ledric): The published binary — `npx -y ledric init` to get started.