Zitadel Preview Docs

Overview

Start here for the current Zitadel preview docs, shipped boundaries, and navigation.

Zitadel's next-generation preview is the successor track for the platform, built around local-first setup, repo-owned configuration, and auth flows that are easy for humans and coding agents to prove end to end.

Zitadel v4 remains maintained while this preview evolves. The preview is pre-release: APIs, CLI flags, packages, and docs can change before this becomes a future major version. The public product name may also change.

Current shipped boundary

The current shipped path is local auth setup through the @zitadel/cli alpha package:

npx @zitadel/cli@alpha doctor
npx @zitadel/cli@alpha start
npx @zitadel/cli@alpha setup --server local

zitadel start runs the released @zitadel/server npm binary by default. It does not require Docker, Go, Moon, or a source checkout. The binary runtime defaults to SQLite. Docker is still available explicitly with zitadel start --runtime docker.

Create-first, claim-later remains product direction, and the claim flow is implemented end to end on the server: the zitadel claim CLI command, the OpenAPI claim endpoints, and the server-side handlers are all shipped. What is still missing is the console claim page, so the browser leg (signing in on the platform project and completing the claim) has no guided UI yet and currently requires driving the API directly.

What to read first

  • Quickstart for the local CLI path.
  • Agent setup for --non-interactive --json and browser proof expectations.
  • Concepts for project, team, user, local runtime, databases, repo config, flows, schemas, SDK proxy, sessions, and auth attempts.
  • CLI for command groups and troubleshooting.
  • SDKs for framework package entrypoints.
  • API reference for OpenAPI-generated endpoint docs.

LLM support

This docs app exposes:

  • /llms.txt for a compact index.
  • /llms-full.txt for full text export.
  • /*.md for page-level Markdown.
  • /api/search for static search.
  • /mcp for MCP clients with search, list page, and get page tools.

On this page