Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/supabase-community/supabase-vscode-extension

Supabase Extension for VS Code and GitHub Copilot.
https://github.com/supabase-community/supabase-vscode-extension

made-with-supabase madewithsupabase supabase-cli vscode-extension

Last synced: 6 days ago
JSON representation

Supabase Extension for VS Code and GitHub Copilot.

Host: GitHub
URL: https://github.com/supabase-community/supabase-vscode-extension
Owner: supabase-community
License: mit
Created: 2023-12-08T17:22:02.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-11-06T07:14:44.000Z (3 months ago)
Last Synced: 2025-01-13T17:59:39.678Z (9 days ago)
Topics: made-with-supabase, madewithsupabase, supabase-cli, vscode-extension
Language: TypeScript
Homepage: https://marketplace.visualstudio.com/items?itemName=Supabase.vscode-supabase-extension
Size: 10.5 MB
Stars: 61
Watchers: 5
Forks: 5
Open Issues: 9
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

        

# Supabase for Visual Studio Code

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

[Features](#features 'Jump to Features')

| [Support and Community](#support-and-community 'Jump to Support and Community')

| [Pricing](#pricing 'Jump to Pricing')

| [Contributing](#contributing 'Jump to Contributing')

| [Contributors](#contributors 'Jump to Contributors')

| [License](#license 'Jump to 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](https://supabase.com/docs/guides/cli/getting-started) and [start](https://supabase.com/docs/guides/cli/getting-started#running-supabase-locally) the Supabase CLI.

The recommended development setup is [documented here](https://supabase.com/docs/guides/cli/managing-environments). 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](https://github.com/features/copilot) 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](./images/copilot_chat.gif)

### Copilot Guided Database Migrations

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

![Copilot guided database migrations demo](./images/copilot_migration.gif)

### Inspect Tables & Views

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

![View tables and views](./images/table_view.png)

### List Database Migrations

See the migration history of your Database.

![Migration History](./images/migration_history.png)

### Inspect Database Functions

Inspect your database functions and their SQL definitions.

![Database functions](./images/database_functions.png)

### List Storage Buckets

List the storage buckets in your Supabase project.

## Support and Community

Support documentation can be found on the [Supabase Support Page](https://supabase.com/support). For community support, you can join the [Supabase Discord Server](https://discord.supabase.com/).

### Issue Reporting and Feature Requests

Found a bug? Have a feature request? Please open an issue on [GitHub](https://github.com/supabase-community/supabase-vscode-extension/issues/new/choose).

## Pricing

Supabase has a [generous free tier](https://supabase.com/pricing), 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](https://database.new/) and [link your local project](https://supabase.com/docs/guides/cli/local-development#link-your-project).

## Contributing

The entire Supabase stack is [fully open source](https://supabase.com/open-source), including this Extension. In fact, this extension was originally created by [Anas Araid](https://github.com/anas-araid) during an [open source hackathon](https://twitter.com/anas_araid/status/1736641409094988033).

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](./CONTRIBUTING.md) docs to get started. Want to contribute to other Supabase projects? Check out the [good first issues](https://github.com/supabase/supabase/contribute).

## Contributors

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

- [Anas Araid](https://github.com/anas-araid)

- [Thor Schaeff](https://github.com/thorwebdev)

## License

MIT