Docs

Quickstart

/* Create a project, copy the connection string, and ship without learning a custom platform first. */

SECTOR 0x01

1. Choose an organization

Sign in, then select or create a Clerk organization from the dashboard header. CAPYDB resolves the active organization from that Clerk context.

SECTOR 0x02

2. Create a project

Open the Projects view, create a project, and choose the target cluster and plan. The control plane will enqueue a provision job and attach the project to the active organization.

SECTOR 0x03

3. Connect

When the project reaches ready state, copy either the direct URL or the pooled URL from the connection details and drop it into your environment variables.

psql "$DATABASE_URL"
SECTOR 0x04

4. Iterate without panic

  • >>Create disposable preview databases for test and review flows
  • >>Create backups before risky changes and restore from recorded backup keys
  • >>Import an existing database from a source URL when moving from another host
  • >>Rotate project credentials without rebuilding the project