Sporades Feature Reference
This is the compatibility index for Sporades feature and command reference material. The exhaustive reference is split by lookup intent so each page stays searchable and navigable. For a task-led path, start with the user guide; for individual SDK signatures, use the generated API reference.
This reference assumes sporades is installed globally. The normal loop is:
sporades create my-capsule --template todo
cd my-capsule
sporades devEdit server/, client/, and shared/; Sporades rebuilds the same Bundle used by Dev, local Container, and Hosted Capsule execution.
About This Reference
Existing links to sections of this former monolithic page remain valid: each legacy anchor below now points to the section's topic-owned reference page.
Projects and Configuration
Capsule creation, project layout, configuration, security policy, database services, and Dev sessions.
Create a Capsule
How Sporades Projects Fit Together
Project Files
Configuration
Use Postgres locally
Security Policy
Start a Dev Session
Server Runtime
Tables, queries, mutations, authorization, Server env, mail, middleware, actors, and Custom endpoints.
Building the Server Side
Define Tables
Read With Queries
Change Data With Mutations
Gate Handlers With requireAuth
Use Sealed Server Env
Create and Import Values
Read Values in Server Code
Export or Import an Envelope
Push to a Hosted Capsule
Recover from Lost Keys
Send SMTP mail
Add Middleware
Choosing a server actor
Custom HTTP Endpoints
Built-in Teams
Runtime-owned Teams, membership application roles, email-bound Join links, and explicit Team ACL decisions.
Team model and compatibility
Manage Teams from a Capsule
Email-bound Join links
Authorize explicit Team resources
Security, storage, and audit boundaries
Jobs and Schedules
Durable background work, Schedule declarations, runtime behavior, and CLI inspection.
Current-user Jobs
Inspect Jobs from the CLI
Inspect Schedules from the CLI
Client, Authentication, and Preferences
Subscribed client state, authentication workflows, provider configuration, and current-user preferences.
Building the Client Side
Use Queries
Use Mutations
Use Auth State
Auth Workflows
Check Auth Configuration
Configure OAuth Providers
Configure Sign in with Apple
Configure Google OAuth
Importing the OAuth client into Sporades
Configure Facebook Login
Configure Microsoft sign-in
Using OAuth sign-in in the client
Use Email Auth
Reset or Change an Email Password
Simulate Local Identities
User Preferences
Files and Realtime
File uploads and publication, App messages, and consented transient User Journey state.
File Uploads
App Messages
User Journey Tracker
Operations and Hosting
Logs, database inspection, Container sessions, Hosted Capsules, Doctor, workflows, and troubleshooting.