Skip to content

Byline-CMS/bylinecms.dev

Byline CMS

A developer-friendly, open-source headless CMS — built with versioning, editorial workflow, and content translation as first-class concerns rather than features bolted on later.

Status: early beta. Core is stable enough to build on, and you're welcome to follow along.

byline-admin

Welcome to the Byline dashboard!

What's different

  • Three pillars, not three plugins. Versioning, editorial workflow, and content translation are foundational and designed to coexist without trade-offs.
  • Universal storage (EAV-per-type). Schemas change without migrations. Documents flatten into typed store_* tables (text, numeric, boolean, datetime, json, file, relation) addressed by a custom path notation — indexable, query-friendly, and the basis for selective field loading.
  • Immutable versioning by default. Every change creates a new UUIDv7-ordered version. "Current" is a pointer, not a mutation.
  • Patch-based updates. Clients accumulate DocumentPatch[]; the server applies them against the reconstructed document. A foundation for collaborative editing later.
  • Schema separated from presentation. Collection definitions are server-safe data; admin UI lives in a parallel defineAdmin() config (think Django models vs ModelAdmin, applied to headless content).

For the longer story, see docs/MISSION.md and docs/ARCHITECTURE.md.

Documentation

Start here

Subsystem reference

  1. docs/CORE-DOCUMENT-STORAGE.md — universal storage (EAV-per-type), the seven typed store_* tables, flatten/reconstruct, immutable versioning, and indicative benchmark numbers.
  2. docs/DOCUMENT-PATHS.md — the path system attribute on documentVersions, useAsPath, the slugifier, the path widget, and per-locale paths as a future phase.
  3. docs/RELATIONSHIPS.md — cross-collection relations, populate, the relation envelope, recursion safety via ReadContext, and hasMany as a future phase.
  4. docs/FILE-MEDIA-UPLOADS.md — field-level uploads, the two-round-trip flow (field upload then document save), beforeStore/afterStore hooks, and variant persistence.
  5. docs/ROUTING-API.md — the internal TanStack-server-fn transport phase, today's server-fn surface, and what triggers a stable HTTP boundary.
  6. docs/AUTHN-AUTHZ.md — two auth realms, abilities and roles, the AbilityRegistry, service-layer enforcement, and the beforeRead hook.
  7. docs/CLIENT-SDK.md@byline/client as an in-process, server-side SDK: read DSL, write surface, populate, status modes, and what it deliberately is not.
  8. docs/RICHTEXT.md — pluggable richtext editor adapter, the current Lexical implementation, and future phases for a second editor.
  9. docs/UIKIT.md@byline/ui as a single brand-coherent UI surface: the foundational kit synced from @infonomic/uikit, the byline-prefixed cascade-layer system, the pnpm sync:uikit workflow, and the ./react/{admin,fields,forms,services} subpath exports.
  10. docs/ACCESS-CONTROL-RECIPES.md — working cookbook of beforeRead patterns: owner-only drafts, multi-tenant scoping, embargo, soft-delete hide, department visibility, self-only.
  11. docs/COLLECTION-VERSIONING.md — Phase 1 (data model + fingerprinting) shipped; Phases 2–5 (history table, fetch-by-version, in-memory forward migration, strict-CI mode) deferred.
  12. docs/CORE-COMPOSITION.md — forward-looking roadmap for createCommand, module registries, a command tree on BylineCore, per-realm request-context builders, and loadConfig().

Package design docs sit close to their packages — e.g. packages/client/DESIGN.md.

Quick start - Experimental CLI

Note: We have an experimental CLI that will attempt to install Byline into an existing TanStack Start application. This has only been tested against up-to-date TanStack Start sites created with the Nitro (agnostic adapter). You can install TanStack Start with:

npx @tanstack/cli@latest create

#or

pnpm dlx @tanstack/cli@latest create

Then be sure to select the Nitro (agnostic) adapter.

◆  Select deployment adapter:
│  ○ None
│  ○ Cloudflare
│  ○ Netlify
│  ● Nitro (agnostic)
│  ○ Railway
└

Once your TanStack Start application is ready you can initialize a Byline installation with:

npx @byline/cli@latest init

#or

pnpm dlx @byline/cli@latest init

If there are any issues, you can follow the example application in this repo under apps/webapp.

IMPORTANT: The core Byline routes will be placed under a pathless route at routes/_byline, with its own route.tsx template. To prevent your front-end TanStack Start application's styling from 'leaking' into the Byline dashboard, you'll need to create or move your top-most layout route into its own pathless layout route - for example, under routes/_font-end or routes/_public - with any styling, headers, footers etc., that might have been in __root.tsx - moved into the route.tsx layout file inside your front-end pathless layout route.

See the TanStack Router docs for File-Based Routing and Virtual File Routes for more information.

Quick start - Development environment and example application (this repo)

git clone git@github.com:Byline-CMS/bylinecms.dev.git
cd bylinecms.dev
pnpm install -g rimraf
pnpm install
pnpm build

Bring up Postgres (Docker, default password test):

cd postgres && mkdir data
./postgres.sh up -d

Initialise the database, run migrations, and seed:

cd packages/db-postgres && cp .env.example .env
cd src/database && ./db_init.sh && cd ../..
pnpm drizzle:migrate

# .env configuration
cd ../../apps/webapp && cp .env.example .env

# generate JWT session key
openssl rand -base64 48
# past the above output into your .env file for
# BYLINE_JWT_SECRET

# Set the seed superadmin username email address and password
# BYLINE_SUPERADMIN_EMAIL=admin@byline.local
# BYLINE_SUPERADMIN_PASSWORD=change-me

pnpm tsx --env-file=.env byline/seed.ts

Then from the project root:

pnpm dev

Open http://localhost:5173/.

Full notes — including the foot-gun protection on db_init, alternate database names, and what the seed does — are in docs/GETTING-STARTED.md.

FAQ

1. Who are you? We’re pretty much nobody — at least not within the usual spheres of influence. We're an agency based in Southeast Asia, and we're fairly certain you've never heard of us. That said, we have a lot of experience building content solutions for clients — and we’re tired of fighting frameworks for core features our clients need and expect.
2. Will this work? We hope so. Early beta means the core is stable enough to build on, but we're still discovering what the edges should look like.
3. What governance structures are you considering? We really like the governance structure of [Penpot](https://community.penpot.app/t/penpots-upcoming-business-model-for-2025/7328). We're committed to 100% open-source software, with no "open core" or "freemium" gotchas.
4. Would you accept sponsorship? Yes!
5. Would you accept venture or seed-round investment? We’re not certain yet, and likely not at this early stage. Our priority is to figure out key aspects of the project first. What we feel strongly about, however, is that community contributions should remain accessible — not locked behind an enterprise or paywalled solution. Ultimately, our governance structure and commitment to being community‑driven will guide any financial decisions we make.
6. What's here now? Byline is in early beta. The storage, versioning, workflow, auth, client SDK, and admin UI are all in place. Expect changes as we move toward v1, but the core architecture is stable.
7. Why the Mozilla Public License (MPL-2.0) Version 2.0?

We chose the MPL as we feel this represents the best balance between community-driven open source software, and allowing commercial value-based services to flourish.

The Mozilla Public License 2.0 (MPL-2.0) is often described as a “file-level copyleft” license. That means it sits somewhere between very permissive licenses (like MIT or BSD) and strong copyleft licenses (like GPL). In simple terms: if someone modifies MPL-licensed source files, those modified files must remain open and distributed under the MPL. However, they can combine those files with their own proprietary code in the same larger project, as long as they keep the MPL files separate and respect the license terms.

This creates a clear boundary. Improvements to the original open-source codebase stay open and benefit the community. At the same time, companies can build additional features, integrations, services, or proprietary modules around it without being required to open-source their entire product. The obligation applies only to the specific MPL-licensed files that are modified or redistributed — not to the entire application.

Practically speaking, if someone uses MPL-licensed software in a commercial product, they can sell that product, host it as a service, or build paid offerings around it. If they modify the original MPL files and distribute those modifications, they must make those specific changes available under the MPL. If they simply link to or use the software without modifying those files, there is no requirement to open their own independent code.

We feel the MPL will help to encourage collaboration and shared maintenance of the core platform, while still supporting sustainable commercial ecosystems — which is why many teams see MPL-2.0 as a pragmatic middle path between fully permissive and strongly reciprocal open-source licenses.

License

Mozilla Public License 2.0. See LICENSE and COPYRIGHT.

Copyright © 2026 Infonomic Company Limited

Major Contributors

About

Byline CMS - a headless, fast, and AI-Ready CMS

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages