serverpod/serverpod

serverpod-configuration

Configure Serverpod — YAML config, environment variables, passwords, run modes, generator.yaml, TLS. Use when setting up environments, API/database/Redis settings, managing secrets or overriding configurations for tests.

原文语言：英语

serverpod-overview

Serverpod overview — what it is, project structure, how to work with. Always use at least once when working with projects that use Serverpod.

原文语言：英语

serverpod-testing

Test Serverpod endpoints and business logic - withServerpod, sessionBuilder, authentication, DB seeding, rollback, streams, running tests. Use when writing server tests or working with serverpod_test.

原文语言：英语

serverpod-endpoints

Define Serverpod endpoints, use Session, pass parameters, and call from client. Use when creating RPC endpoints, working with Session, or client code generation.

原文语言：英语

serverpod-migrations

Serverpod database migrations — when and how to create/apply/repair migrations. Use whenever database schema changes are involved.

原文语言：英语

serverpod-models

Define Serverpod data models in YAML (.spy.yaml) — fields, defaults, database tables, relations, enums, exceptions. Use when creating or editing .spy.yaml files. To query the generated ORM instead, use serverpod-database.

原文语言：英语

serverpod-upgrading

Upgrade Serverpod — minor/patch updates, major upgrades (2.x to 3.0, 3.x to 4.0). Use when upgrading Serverpod versions or updating dependencies.

原文语言：英语

serverpod-auth

Serverpod authentication — signing in users, checking whether they are authenticated, assigning scopes (e.g. admin). Use when adding features that require the user to be signed in.

原文语言：英语

serverpod-scheduling

Schedule future work in Serverpod — FutureCall, callWithDelay, callAtTime, recurring tasks, cancellation. Use when scheduling one-off or recurring tasks.

原文语言：英语

serverpod-file-uploads

File uploads in Serverpod — upload descriptions, verification, storage backends (database, S3, GCP). Use when implementing file uploads or cloud storage.

原文语言：英语

serverpod-webserver

Serverpod web server (Relic) — REST APIs, webhooks, middleware, static files, server-rendered HTML, SPAs, Flutter web. Use when adding raw HTTP routes, serving web pages or web apps, or intercepting requests. Not for RPC endpoints called from the generated…

原文语言：英语

serverpod-caching

Serverpod caching — local and Redis caches, cache keys, lifetime, CacheMissHandler. Use when caching data, optimizing queries, or working with session.caches.

原文语言：英语

serverpod-database

Serverpod ORM with PostgreSQL or SQLite — CRUD, filters, sorting, pagination, includes, transactions, raw SQL, client-side database. Use when reading or writing data at runtime. To declare tables and relations instead, use serverpod-models.

原文语言：英语

serverpod-deployment

Deploying and hosting a Serverpod server, with Serverpod Cloud as the default. Use when the user asks how to deploy, ship, host or run their server in production. Deploying is the user's decision, not something to carry out for them.

原文语言：英语

serverpod-flutter-frontend

Build highly distinctive, production-ready Flutter interfaces with exceptional design fidelity. Use when designing a new app or new screens from scratch, where no visual language is established yet. Do not use when extending or fixing screens in an app that…

原文语言：英语

serverpod-health-checks

Serverpod health endpoints — /livez, /readyz, /startupz, custom HealthIndicator, HealthConfig. Use when configuring Kubernetes probes or monitoring server health.

原文语言：英语

serverpod-logging

Serverpod logging — session.log, log levels, persistence, retention, console output. Use when adding logging or debugging server calls.

原文语言：英语

serverpod-sessions

Serverpod session types, lifecycle, InternalSession, cleanup callbacks. Use when creating sessions manually outside a request, when work outlives the request that started it, or when a closed session throws a StateError.

原文语言：英语

serverpod-server-events

Serverpod message system — postMessage, addListener, createStream, global messages via Redis. Use when coordinating streams, sharing state across servers, or pub/sub messaging.

原文语言：英语

serverpod-streams

Real-time streaming in Serverpod — Stream parameters and return types, WebSocket lifecycle, error handling. Use when building real-time features, chat, live updates, or WebSocket streaming.

原文语言：英语

serverpod-modules

Create and use Serverpod modules — adding modules, generator.yaml nicknames, model references, creating custom modules. Use when working with modules or shared server/client code.

原文语言：英语