Skip to main content
Settings control what each new branch looks like for the currently selected connector: which database name appears in connection URLs, what SQL runs after branch creation, and how local tooling points at a branch. The command group is ardent settings.
KeyDescription
default_dbDefault database name used in branch connection strings
branch_sqlSQL, or @path/to/file.sql, executed once on every new branch after it is created

Branch configuration and anonymization

branch_sql gives teams repeatable control over branch contents without maintaining one-off scripts for every developer. Common uses:
  • Redact or anonymize sensitive values on every branch.
  • Add fixtures, baseline rows, or organization-specific setup.
  • Apply guardrail DDL your app expects in isolated environments.
For security-focused anonymization patterns, see Security.
branch_sql runs on new branches, not on your source database. Keep the SQL idempotent where possible so branch creation is predictable.

ardent settings list

ardent settings list
Connector: prod-db
  default_db   myapp
  branch_sql   (not set)   SQL to run on every new branch after creation

ardent settings set

Set the default database name used in branch URLs:
ardent settings set default_db myapp
Pass a file for branch_sql:
ardent settings set branch_sql @./branch-init.sql
✓ Set default_db → myapp

ardent settings remove

ardent settings remove branch_sql
✓ Removed branch_sql

Local Supabase linking

If you use Supabase locally, Ardent can point your local Supabase services at an Ardent branch. This is useful when you want local auth, REST, realtime, or edge-function tooling to run against an isolated branch instead of your local Postgres container.

ardent settings supabase status

Check whether a local Supabase project is currently linked:
ardent settings supabase status
If more than one local Supabase project is available, pass the project name:
ardent settings supabase status --project my-app
Link local Supabase to the current Ardent branch:
ardent settings supabase link
Or link to a specific branch:
ardent settings supabase link my-feature --project my-app
The CLI checks that local Supabase is reachable before changing configuration. Use --skip-health-check only when you know the services are intentionally stopped and you want to update configuration now:
ardent settings supabase link my-feature --skip-health-check
Restore local Supabase to its local database configuration:
ardent settings supabase unlink
Use --project <project> if the CLI asks you to disambiguate.