Supabase CLI工具 #

# macOS - Homebrew
brew install supabase/tap/supabase

# Windows - Scoop
scoop bucket add supabase https://github.com/supabase/scoop-bucket.git
scoop install supabase

# Windows - Chocolatey
choco install supabase

# Linux
curl -fsSL https://sup.supabase.com/install.sh | bash

# npm
npm install -g supabase

supabase --version

# 登录Supabase账号
supabase login

# 查看登录状态
supabase projects list

# 链接到远程项目
supabase link --project-ref your-project-ref

# 查看链接状态
supabase link

# 初始化本地项目
supabase init

# 生成的文件
# supabase/
# ├── config.toml
# ├── migrations/
# ├── functions/
# └── seed.sql

# 启动所有本地服务
supabase start

# 输出
# API URL: http://localhost:54321
# DB URL: postgresql://postgres:postgres@localhost:54322/postgres
# Studio URL: http://localhost:54323
# Inbucket URL: http://localhost:54324
# anon key: ...
# service_role key: ...

# 停止服务
supabase stop

# 停止并删除数据
supabase stop --no-backup

# 查看服务状态
supabase status

# 创建新迁移
supabase migration new create_users_table

# 应用迁移到本地
supabase db push

# 应用迁移到远程
supabase db push --linked

# 查看迁移列表
supabase migration list

# 重置本地数据库
supabase db reset

# 执行SQL
supabase db execute --sql "SELECT * FROM users"

# 执行SQL文件
supabase db execute -f queries/select_users.sql

# 连接数据库
supabase db psql

# 远程数据库连接
supabase db psql --linked

# 比较本地和远程差异
supabase db diff

# 生成迁移文件
supabase db diff --schema public --use-migra

# 创建新函数
supabase functions new my-function

# 本地运行函数
supabase functions serve

# 部署函数
supabase functions deploy my-function

# 部署所有函数
supabase functions deploy

# 删除函数
supabase functions delete my-function

# 查看函数日志
supabase functions logs my-function

# 实时日志
supabase functions logs my-function --follow

# 设置密钥
supabase secrets set MY_SECRET=value

# 从文件设置
supabase secrets set --env-file .env

# 查看密钥列表
supabase secrets list

# 删除密钥
supabase secrets delete MY_SECRET

# 从本地数据库生成
supabase gen types typescript --local > lib/database.types.ts

# 从远程项目生成
supabase gen types typescript --project-id your-project-id > lib/database.types.ts

# 使用链接项目
supabase gen types typescript --linked > lib/database.types.ts

# 列出所有项目
supabase projects list

# 创建新项目
supabase projects create my-project

# 删除项目
supabase projects delete my-project

# 项目配置
[project]
name = "my-project"

# API配置
[api]
port = 54321
schemas = ["public", "storage", "graphql_public"]
extra_search_path = ["public", "extensions"]
max_rows = 1000

# 数据库配置
[db]
port = 54322
shadow_port = 54320
major_version = 15

# 认证配置
[auth]
site_url = "http://localhost:3000"
additional_redirect_urls = ["http://localhost:3000/auth/callback"]
jwt_expiry = 3600
enable_signup = true

# 存储配置
[storage]
file_size_limit = "50MiB"

# Edge Functions配置
[edge_runtime]
enabled = true