Skip to content

supabase-community/supabase-vscode-extension

Repository files navigation

preview

Supabase for Visual Studio Code

Supercharge your productivity by integrating your local Supabase instance into your favourite editor.

Features | Support and Community | Pricing | Contributing | Contributors | License

Getting Started

Install the Supabase VS Code Extension by clicking Install on the banner above, or from the Extensions side bar in VS Code, by searching for Supabase.

Dependencies

Supabase CLI

The Extension currently requires Supabase to be running locally. Follow the steps to install and start the Supabase CLI.

The recommended development setup is documented here. To get up and running, follow these steps:

  • Init your local project: supabase init
  • Link your cloud project to your local project: supabase link
  • Pull down the database from your cloud project: supabase db pull
  • Now your database is in sync and you can start it locally: supabase db start

GitHub Copilot

To use the Copilot Chatparticipant integration an active GitHub Copilot subscription is required. A free trial is available.

Features

GitHub Copilot Chat Participant

This Extensions provides a GitHub Copilot Chat Participant to help with your Supabase questions. Simply type @supabase in your Copilot Chat and the extension will provide your Database schema as context to Copilot.

Copilot Chat integration demo

Copilot Guided Database Migrations

The Extension provides a guided experience to help you create and apply database migrations. Simply type @supabase /migration <describe what you want to do> in your Copilot Chat and the extension will generate a new SQL migration for you.

Copilot guided database migrations demo

Inspect Tables & Views

Inspect your tables and views, including their columns, types, and data, directly from the editor!

View tables and views

List Database Migrations

See the migration history of your Database.

Migration History

Inspect Database Functions

Inspect your database functions and their SQL definitions.

Database functions

List Storage Buckets

List the storage buckets in your Supabase project.

Support and Community

Support documentation can be found on the Supabase Support Page. For community support, you can join the Supabase Discord Server.

Issue Reporting and Feature Requests

Found a bug? Have a feature request? Please open an issue on GitHub.

Pricing

Supabase has a generous free tier, giving you a fully fledged Postgres Database for every project. Running Supabase locally is completely free and doesn't require any account! Once you're ready to deploy your project, you can sign up for a free account and link your local project.

Contributing

The entire Supabase stack is fully open source, including this Extension. In fact, this extension was originally created by Anas Araid during an open source hackathon.

Your contributions, feedback, and engagement in the Supabase community are invaluable, and play a significant role in shaping our future. Thank you for your support!

Want to contirbute to this Extension? Follow the CONTRIBUTING docs to get started. Want to contribute to other Supabase projects? Check out the good first issues.

Contributors

A big thanks to the people that have contributed to this project 🙏❤️:

License

MIT