Supabase CLI

Features

• Manage Postgres database migrations
• Run Supabase locally
• Deploy Edge Functions
• Generate types from database schema
• Manage Storage objects
• Manage project secrets and configurations

Use Cases

• Setting up a new Supabase project locally for development.
• Automating database schema changes through migration scripts.
• Deploying and managing serverless Edge Functions.
• Interacting with Supabase Storage buckets and objects.
• Generating type definitions for your database schema to improve type safety in client applications.

Non-Goals

• Managing Supabase project creation or deletion directly via a graphical interface.
• Replacing the Supabase Dashboard for all project management tasks.
• Handling frontend development for Supabase applications.

Workflow

1. Initialize project with `supabase init` or bootstrap from template.
2. Start local Supabase services with `supabase start`.
3. Manage database schema with `supabase migration` commands or declarative `supabase db schema` commands.
4. Deploy functions with `supabase functions deploy`.
5. Manage storage with `supabase storage` commands.
6. Link to a remote project with `supabase link` to manage remote resources.

Practices

• Database migrations
• Local development environment
• Serverless function deployment
• API key management
• Schema generation