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
npx @zitadel/cli@alpha console

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. It also creates a local admin, admin@zitadel.localhost, and zitadel console prints a one-time link that signs you in to the management console as that admin.

Create-first, claim-later remains product direction, and the claim flow is implemented end to end: the zitadel claim CLI command, the OpenAPI claim endpoints, the server-side handlers, and the console claim page (the browser leg where you sign in on the platform project and complete the claim) are all shipped. Locally there is nothing to claim: zitadel setup --server local by default attaches the new project to the local admin's team, so it is owned as soon as setup finishes.

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.