# Galerne documentation

> What Galerne is, how its parts fit together, and where to start.

Galerne is a headless CMS hosted in the European Union. You describe your content model in code, people edit content in the studio, sites read it through a JSON API, and agents read and write it through an MCP server. Every project has its own database.

## How the parts fit

| Part | What it is | Where |
|---|---|---|
| Studio | The editing app: documents, media, branches, reviews, comments, settings | `https://studio.galerne.cloud` |
| API | Delivery, writes, media, webhooks, export and import, per project | `https://api.galerne.cloud/p/<project>/v1` |
| MCP server | The same tools for agents, over streamable HTTP | `https://api.galerne.cloud/p/<project>/mcp` |
| CLI | `galerne`: schema deploys, content, branches, export, import, a local MCP server | `npm i -g @galerne/cli` |
| Client | A typed TypeScript client with no runtime dependencies, plus small Python and PHP clients | `npm i @galerne/client` |

The API, the MCP server and the CLI share one tool registry: one definition per operation, with the same inputs, permissions and errors everywhere. The [MCP tools](/docs/tools.md) page lists all of them.

## Start here

- [Quickstart](/docs/quickstart.md): create a project, deploy a schema, query it from a site.
- [Agent quickstart](/docs/agent-quickstart.md): create a project and a token, give one prompt with your brief to an agent, and it builds and publishes the whole site.
- [Full site tutorial](/docs/tutorial.md): a hosted site with two languages, a GitHub data source, review and a release, by hand or with an agent.
- [Schema](/docs/schema.md): every field type and option of `galerne.config.ts`.
- [Query API](/docs/query.md): filters, ordering, projections, references, languages and branches.
- [Agents and permissions](/docs/agents.md): connect Claude, Cursor or ChatGPT, and set what each agent may do.
- [Branches and review](/docs/branches.md): how changes wait, merge and go live.

[Everything Galerne does](/platform) walks through each capability with a short example.

## By topic

- Content: [schema](/docs/schema.md), [query API](/docs/query.md), [media](/docs/media.md), [languages and translations](/docs/translations.md), [the studio](/docs/studio.md).
- Workflow: [branches and review](/docs/branches.md), [comments and history](/docs/comments-history.md), [scheduling and releases](/docs/scheduling.md).
- Agents: [agents and permissions](/docs/agents.md), [MCP tools](/docs/tools.md).
- Integrate: [HTTP API](/docs/api.md), [clients](/docs/client.md), [Next.js kit](/docs/nextjs.md), [webhooks](/docs/webhooks.md), [event stream](/docs/events.md), [data sources](/docs/sources.md), [CLI](/docs/cli.md), [site settings](/docs/site.md), [visual editing](/docs/visual-editing.md).
- Sites: [sites and code](/docs/sites.md), [site template](/docs/site-template.md), [design browser](/docs/design-browser.md).
- Move: [migrating](/docs/migrate.md), [export format](/docs/export.md).
- Account: [members and tokens](/docs/members.md), [SSO and SCIM](/docs/sso.md), [limits and plans](/docs/limits.md), [billing](/docs/billing.md).

## Words we use

- **Project**: one content space with its own database, members, tokens and plan. Its slug appears in every URL.
- **Document**: one entry of a type, with a draft and, once published, a published version.
- **Branch**: a set of changes that waits until someone promotes it into `main`. `main` is the live content.
- **Perspective**: `published` reads what sites see; `drafts` reads the latest edits.
- **Member**: a person or an agent in a project, with a role.
- **Token**: a `gal_…` secret that acts as a member or as the project, with scopes.

## For agents

Every page of these docs is also plain Markdown: add `.md` to the URL, or read [llms.txt](/llms.txt) for the index and [llms-full.txt](/llms-full.txt) for everything in one file.
