Today we are moving the Supabase CLI v1 out of beta. The Supabase CLI is capable of managing database migrations and generating TypeScript types. Follow these install instructions to get started.
In addition, we are releasing a Management API (in beta). The Management API is a REST API that allows you to manage organizations, projects, Edge Functions, and more. You can read the API docs or interact with the Management API from the Supabase CLI v1.
(Note: The Management API was previously called the Admin API.)
Watch the CLI team announcing the new features.Manage organizations, projects, Edge Functions, and more
If you've used Supabase Edge Functions, you've used the Supabase CLI. We're extending it to let you manage organizations and projects.
supabase login
supabase orgs list
supabase projects create my-project --org-id cool-green-pqdr0qc --db-password ******** --region us-east-1
Once your new Supabase project is created, use the CLI to link it locally to begin development.
supabase link --project-ref <project-id>
View the Supabase CLI docs for the full list of available commands.
Schema migrations
You asked for more database migration support, and we listened. We've made improvements to manually-written migrations and auto generated schema diffs.
Schema diff-ing
Previously we supported schema diff-ing using PgAdmin. We found that the tool did not account for default privileges when generating role grants. This leads to verbose statements when diff-ing complex schema changes.
To improve the usability of db diff command, we are introducing another tool, migra, via the --use-migra experimental flag. We found that migra runs faster and produces more concise DDL statements. While the generated scripts are not perfect, we hope this tool helps you iterate quicker on your migration scripts. Over time (and with your feedback) we hope to improve schema-diffing to cover all edge-cases.
$ supabase db diff --use-migra --file file_name
# Creates a DDL script: supabase/migrations/<datetime_string>_file_name.sql
Running the above command diffs the public schema of your local development database against a fresh shadow database. You may specify other schema by passing in the --schema flag multiple times or as a comma separate list. More details in our migration guide.
In the long-term we hope to consolidate on a single diff-ing tool which is perfect, but diff-ing is hard so we would need your help and feedback to improve tooling.
Manual migrations
You can test manual migrations locally without data loss using local branching. Run the following commands to clone your local database to a new branch.
supabase db branch new my_branch
supabase db branch switch my_branch
Now you can run any DDL statements from Studio UI's SQL Editor. To undo the changes, simply switch back and delete the new branch.
supabase db branch switch main
supabase db branch delete my_branch
CI / CD
Automating migrations and tests on your CI / CD pipeline gives developers more confidence that each PR contains a working migration script. CLI v1 focuses on both local and GitHub Actions support for the following workflows.
Test all migrations on a fresh local database:
supabase init
supabase start
Release schema changes to staging and production:
$ supabase link --project-ref $PROJECT_ID
$ supabase db push
We created an example project showing how to set up GitHub Actions to test and migrate with Supabase CLI v1.
Type generation
You can now generate TypeScript types using the CLI:
# in a project set up with the CLI:
supabase gen types typescript --local
supabase gen types typescript --db-url $SUPABASE_DB_URL
Of course, the types aren't very useful on its own, you need some way to consume it. For that, stay tuned for tomorrow! 😉
Management API
The CLI is the first consumer of our new Management API. Over the next few weeks, we'll be adding the endpoints needed to programmatically manage your Supabase projects and organizations. This is ideal for CI/CD workflows and spinning up test environments.
Here's an example of deploying a new project from the command line (generate your access token from the Supabase Dashboard).
curl 'https://api.supabase.com/v1/projects' \
-H 'Authorization: Bearer <[your-access-token](https://app.supabase.com/account/tokens)>' \
-H "Content-Type: application/json" \
-d '{"name": "my-project", "organization_id": "cool-green-pqdr0qc", "region": "us-east-1", "plan": "free", "db_pass": "********"}'
The response JSON will match the example below:
{
"id": "abcdefghijklmnopqrst",
"organization_id": "cool-green-pqdr0qc",
"name": "hello",
"region": "us-east-1",
"created_at": "2022-08-12T17:37:11.88819Z"
}
Check out the API docs to browse all the functionality added so far.
The new API also opens the door to a whole new suite of integrations, including Zapier, Terraform, Pulumi etc. We're looking forward to seeing how the dev community interacts with these new public endpoints. Try it out and let us know which functionality you'd like to see next.