Aurabase Documentation
Everything you need to build, deploy and scale your applications on Aurabase. Concepts, practical guides, SDK and API references.
Where to start?#
- Quick start
Zero to an API in 5 minutes — Postgres + realtime included.
- Architecture
Eight services, one network. Isolation by project schema.
- JavaScript SDK
Client typed for Next.js, React, Node, Bun, Deno.
Start with a task#
Each link opens the page that walks through the task.
- Query data
Read, write and count rows with aura.from(), and call SQL functions with rpc().
- Authenticate users
Sign users up and in, follow session changes, and manage sessions and MFA.
- Upload files
Create buckets, upload and download files, and share them with public or signed URLs.
- Subscribe to changes
Open realtime channels, listen to table changes, broadcast messages and track presence.
- Deploy a function
Create, deploy and call an Edge Function with the aura CLI.
- Migrate from Supabase
Move a Supabase project: same client API and RLS policies.
- Migrate from Firebase
Move Firestore data, Auth users, Storage files and Cloud Functions.
Build with an agent#
Give this prompt to your coding agent (Claude Code, Cursor, Codex…). It points the agent to the documentation index and to the MCP server of your project.
Prompt for your coding agent
Use Aurabase as the backend of this app.
Documentation: read https://aurabase.cloud/llms.txt first. Every docs page is also available as Markdown: add .md to its URL, for example (the same works for every page): https://aurabase.cloud/en/docs/getting-started.md
Client: install @aurabase/aurabase-js and create the client with createClient(NEXT_PUBLIC_AURABASE_URL, NEXT_PUBLIC_AURABASE_ANON_KEY). Keep AURABASE_SERVICE_ROLE_KEY on the server: never put it in client code.
Project access: to read the schema and run SQL, start the Aurabase MCP server over stdio (82 tools with a project key):
npx -y -p @aurabase/mcp-server aurabase-mcp --url https://<slug>.aurabase.cloud --project-id <project-id> --service-role-key aura_sk_…
The project id is in Studio › Settings › General. The service role key is shown once when the project is created; regenerate it in Studio › Settings › Connection if you lost it.Products in detail#
- Database (Postgres)
Dedicated Postgres, isolated schemas, RLS, migrations, TS codegen.
- NoSQL Document Store
MongoDB-compatible engine, dynamic JSON collections, aggregation pipelines.
- Auth
15 OAuth providers, MFA TOTP, granular RBAC.
- Realtime
Self-negotiated WebSocket, SSE, NATS. Presence, replay, cursors.
- Storage
S3-compatible, transforms AVIF/WebP, signed URLs, CDN 12 regions.
- Edge Functions
Deno and WASM multi-runtime, cron, DLQ, AI Gateway, preview deployments.
SDKs & APIs#
- Javascript SDK
Complete reference · Next.js, React, Node, Bun, Deno
- REST API
Stripe-style reference with request/response
Community and support#
The Discord community responds on average within 15 minutes. For Enterprise support (dedicated Slack, 15 min SLA, success manager), see Enterprise plans.
| Channel | Link |
|---|---|
| Discord | discord.gg/62HY9GprNc |
| GitHub | github.com/Aurabase-cloud/Aurabase |
| Crates.io | crates.io/crates/aurabase |
| npm registry | @aurabase/aurabase-js |
| Technical blog | aurabase.hashnode.dev |
| Community | dev.to/daylami |
| Status | aurabase.cloud/en/status |