Skip to content

Introduction

Plenary is a hybrid CMS. Editors manage structured content and design pages visually in a web console; your own front end fetches that content over an HTTP API and renders it. Plenary never renders your public site. It stores and serves content, and your Next.js app (or any other HTTP client) turns it into pages.

Plenary combines two ways of working with content in one system:

  • Headless content. You define content models (an Article, an Event, a Site Settings singleton), editors fill them in, and your code reads published entries as JSON from the Content API.
  • Visual page building. A content model can include a blocks field. Editors compose that field from components in the Page Builder, which shows a live preview of your site while they work. The stored value is a JSON component tree that your front end renders with your own React components.

Both live side by side. A model can hold plain fields, a blocks field, or both, and they are all read through the same API.

  • Developers who want content in a typed JSON API, with the rendering, routing, and hosting of the site left entirely to them.
  • Editors and marketers who need to write, schedule, translate, and lay out pages without a deploy.
  • AI coding agents working for either of the above. These docs are written so an agent can follow them literally; see Building with AI Agents.
Piece What it is Where it lives
Instance One running Plenary installation: the API, the console, media processing, and a MongoDB database. Plenary Cloud, or your own infrastructure
Console The admin web app where editors and admins manage models, entries, media, forms, users, and settings. https://your-instance/cms
API The HTTP API your site and tools call. Content reads use a public API key in the X-API-KEY header. https://your-instance/api/v1
SDK TypeScript packages for consuming Plenary: @plenary/client (fetching content and submitting forms), @plenary/react (rendering Page Builder content), @plenary/next (Next.js caching and revalidation), and @plenary/core (shared types). npm, version 1.0.x
CLI @plenary/cli, the plenary command: syncs model YAML, manages entries and media, and calls any API endpoint from a terminal or CI. npm, version 1.0.x

Start with the SDK overview to see how the packages fit together, and the CLI reference for the command line.

You can run Plenary two ways. The product is the same; the difference is who runs the infrastructure.

  • Plenary Cloud. Sign up at plenarycms.com and get an instance at https://<your-subdomain>.plenarycms.io. Plenary runs the servers, database, email delivery, and media storage.
  • Self-hosted. Run the Plenary Docker image on your own infrastructure with your own MongoDB. You configure email, SMS, and media storage yourself, and install a license.

Everything you build against an instance (models, entries, API keys, SDK code) works the same on both.

Section Use it when you want to
Getting Started Understand Plenary and get your first content on screen. Read Core Concepts and the Quickstart first.
Guides Learn one feature end to end, with the console steps and the API/SDK way side by side.
Examples Copy a complete, working build, such as a Next.js blog or a contact form.
Reference Look up an exact endpoint, parameter, field type, error code, or permission.
SDK Look up every export and signature of the @plenary/* packages.

If you are building with an AI coding agent, point it at /llms.txt (an index of every page) or /llms-full.txt (the full docs in one file), and read Building with AI Agents for setup and prompting advice.

  • Core Concepts: the vocabulary every other page uses.
  • Quickstart: create a model, publish an entry, and fetch it from Next.js.