Getting Started
There are two ways to get started with Byline:
- Experimental CLI — install Byline into an existing TanStack Start application with
byline init(plussetupanddoctor). - Development environment and example application — clone this repo, provision PostgreSQL, seed the database, and run the example app (
apps/webapp) in dev mode.
If you're evaluating Byline, the development environment is the quickest way to see a working install; the CLI is the path to adding Byline to your own app.
Where to go next
- Understand the model — Architecture is the map of the load-bearing decisions (universal storage, immutable versioning, the schema/admin split).
- Model your content — Collections is the working reference for defining a collection, its fields, relationships, and rich text.
- Read it back out — the Client SDK is how a frontend or script queries and writes Byline content.
- Why it exists — Why Byline sets out the motivation and the stance on AI-era content.