功能描述

Manage Volcengine Supabase workspaces, branches, SQL queries, migrations, Edge Functions, Storage, and TypeScript type generation via a local CLI. Run uv run...

使用说明 (SKILL.md)

火山引擎 Supabase

Name: Byted Supabase
Author: volcengine-skills

本 Skill 用于在对话中充当火山引擎 Supabase 的智能运维与开发代理。

它会：

识别用户的 Supabase 自然语言需求
直接调用 scripts/call_volcengine_supabase.py 获取实时结果
基于返回结果做解释、排障和下一步建议

何时使用本 Skill

适用场景（应使用）：

用户提到 Supabase、火山引擎 Supabase 相关的操作需求
需要创建、查看、暂停或恢复 Supabase 工作区（workspace）
需要对 Supabase 数据库执行 SQL 查询、建表、迁移
需要管理 Supabase 分支（创建、删除、重置）
需要部署或管理 Edge Functions
需要操作 Storage Bucket（创建、删除、查看配置）
需要获取 Supabase 项目的 API Key 或 连接信息
需要为 Supabase 数据库 生成 TypeScript 类型定义

不适用场景（无需使用）：

仅讨论通用数据库概念，不涉及火山引擎 Supabase 实例
操作非 Supabase 的数据库服务（如 RDS MySQL、Redis）
纯前端 / 客户端代码编写，不涉及 Supabase 后端资源管理
用户只是询问 Supabase 文档 / 概念，无需调用 CLI

运行方式

# 方式 1：使用 uv（推荐）
uv run ./scripts/call_volcengine_supabase.py \x3Caction> [options]

# 方式 2：使用 python（需预装依赖）
python ./scripts/call_volcengine_supabase.py \x3Caction> [options]

前置条件

必需环境变量：VOLCENGINE_ACCESS_KEY、VOLCENGINE_SECRET_KEY（如果在沙箱环境/vefaas IAM 环境下运行，将自动获取临时凭证，可不配置环境变量）
可选环境变量：VOLCENGINE_REGION、DEFAULT_WORKSPACE_ID、READ_ONLY、SUPABASE_WORKSPACE_SLUG、SUPABASE_ENDPOINT_SCHEME
若未配置依赖，可先执行：uv pip install -r requirements.txt 或 pip install -r requirements.txt

标准使用流程

先确认目标资源：workspace_id 或 branch_id
优先执行只读查询，确认现状
需要变更时，再执行写操作
变更后再次查询，确认结果已生效

常用命令示例

# 查看可访问的 workspace
uv run ./scripts/call_volcengine_supabase.py list-workspaces

# 查看 workspace 详情
uv run ./scripts/call_volcengine_supabase.py describe-workspace --workspace-id ws-xxxx

# 获取 workspace URL
uv run ./scripts/call_volcengine_supabase.py get-workspace-url --workspace-id ws-xxxx

# 查看分支
uv run ./scripts/call_volcengine_supabase.py list-branches --workspace-id ws-xxxx

# 执行 SQL
uv run ./scripts/call_volcengine_supabase.py execute-sql --workspace-id ws-xxxx --query "SELECT * FROM pg_tables LIMIT 5"

# 从文件执行 migration
uv run ./scripts/call_volcengine_supabase.py apply-migration --workspace-id ws-xxxx --name create_todos_table --query-file ./migration.sql

# 部署 Edge Function
uv run ./scripts/call_volcengine_supabase.py deploy-edge-function --workspace-id ws-xxxx --function-name hello --source-file ./index.ts

# 创建 Storage bucket
uv run ./scripts/call_volcengine_supabase.py create-storage-bucket --workspace-id ws-xxxx --bucket-name uploads --public

能力范围

工作区与分支

list-workspaces
describe-workspace
create-workspace
pause-workspace
restore-workspace
get-workspace-url
get-keys
list-branches
create-branch
delete-branch
reset-branch

数据库

execute-sql
list-tables
list-migrations
list-extensions
apply-migration
generate-typescript-types

Edge Functions / Storage

list-edge-functions
get-edge-function
deploy-edge-function
delete-edge-function
list-storage-buckets
create-storage-bucket
delete-storage-bucket
get-storage-config

应用开发参考

在使用本 Skill 管理 Supabase 资源的同时，以下文档提供应用开发场景的指导：

需求	文档
将 Supabase 接入 TS/Python 应用（SDK 初始化 + CRUD）	`references/app-integration-guide.md`
数据库表结构设计与迁移规范	`references/schema-guide.md`
行级安全策略（RLS）配置	`references/rls-guide.md`
Edge Function 编写与部署	`references/edge-function-dev-guide.md`

💡 典型工作流：先用 CLI 创建 workspace / 建表 / 配置 RLS，再参考应用开发文档在业务代码中集成 Supabase SDK。

注意事项

默认遵循“先查后改”
get-keys 默认脱敏，只有明确需要时才加 --reveal
reset-branch 会丢失未追踪变更，且后端当前会忽略 migration_version
READ_ONLY=true 时，所有写操作会被拒绝

参考资料

工具说明：references/tool-reference.md
操作流程：references/workflows.md
SQL 示例：references/sql-playbook.md
应用集成：references/app-integration-guide.md
Schema 设计：references/schema-guide.md
RLS 策略：references/rls-guide.md
Edge Function 开发：references/edge-function-dev-guide.md

安全使用建议

This skill implements a real Volcengine Supabase CLI and the included Python code matches the SKILL.md, but there are two red flags you should consider before installing or running it: (1) the skill actually requires VOLCENGINE_ACCESS_KEY and VOLCENGINE_SECRET_KEY (and may fetch temporary credentials from vefaas IAM), yet the registry metadata didn't declare these sensitive env vars — treat any key you provide as powerful and limit its privileges and lifetime; (2) the requirements list pulls a volcengine SDK directly from a GitHub user repo (git+https), not an official vetted package — installing will execute unreviewed code from that repo. Recommended steps: review the included Python files yourself (they are bundled), run the tool in an isolated environment or container, avoid using long-lived or high-privilege keys (use least privilege or temporary creds), enable READ_ONLY first to test behavior, and only pip-install dependencies after you inspect the VCS dependency or replace it with a trusted SDK release. If you need higher assurance, ask the publisher for a canonical package source or an explicit list of required env vars in the registry metadata.

能力评估

⚠ Purpose & Capability

Name/description, SKILL.md, and the bundled Python code all implement Volcengine Supabase management (workspaces, branches, SQL, Edge Functions, Storage). However the registry metadata lists no required environment variables or primary credential while SKILL.md and the code clearly require VOLCENGINE_ACCESS_KEY and VOLCENGINE_SECRET_KEY (and can fetch temporary credentials from a vefaas IAM helper). The missing declaration of these sensitive env vars in the skill metadata is an incoherence that affects trust/permission reasoning.

ℹ Instruction Scope

Runtime instructions are explicit: run the included scripts via 'uv run' or python and pass actions/flags. The CLI reads local files (e.g., migration.sql, source files) when you supply file arguments and it can return API keys via get-keys (--reveal needed to show secrets). That behavior is consistent with the stated purpose, but the SKILL.md also instructs installing requirements manually (uv pip install -r requirements.txt) — so using the skill will typically cause additional code to be installed and executed locally. The instructions do not ask the agent to read unrelated host files, but user-supplied file paths will be read by the tool.

⚠ Install Mechanism

No automated install spec is declared (instruction-only), but a requirements.txt is included and the README suggests running pip install -r requirements.txt. The requirements reference a git+https URL to 'github.com/sjcsjcsjc/volcengine-python-sdk' rather than an official, well-known package repo — installing that pulls code from an external, user-controlled VCS URL which increases risk (supply-chain/execution of unreviewed code).

⚠ Credentials

The skill requires Volcengine credentials (VOLCENGINE_ACCESS_KEY and VOLCENGINE_SECRET_KEY) and may obtain temporary credentials from a vefaas IAM helper if available. Those credentials are proportionate to managing Volcengine Supabase resources, but they are sensitive and the skill metadata did not declare them. The tool can also expose API keys via 'get-keys' (with a --reveal flag). Requesting broad Cloud API keys is reasonable for the purpose but needs clear, explicit declaration and user caution.

✓ Persistence & Privilege

always:false and normal autonomous invocation settings (disable-model-invocation:false) are used. The skill does not request permanent platform-level privileges or declare 'always:true'. It does not appear to modify other skills or global agent settings. Running the bundled scripts will execute code in the current environment but there is no evidence of hidden persistence mechanisms in the provided files.

版本历史

v1.0.0

Initial release of byted-supabase: - Provides CLI management for Volcengine Supabase workspaces, branches, SQL, migrations, Edge Functions, Storage, and TypeScript type generation. - Uses ./scripts/call_volcengine_supabase.py to handle real-time tasks via uv or Python CLI. - Includes detailed usage scopes, workflows, command examples, and environment variable guidance. - Covers both typical backend management scenarios and integration with application development documentation. - Restricts scope to Supabase resource management; not for generic database operations or unrelated frontend tasks.

元数据

Slug byted-supabase

版本 1.0.0

许可证 MIT-0

累计安装 0

当前安装数 0

历史版本数 1

常见问题

Byted Supabase 是什么？

Manage Volcengine Supabase workspaces, branches, SQL queries, migrations, Edge Functions, Storage, and TypeScript type generation via a local CLI. Run uv run... 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 91 次。

如何安装 Byted Supabase？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install byted-supabase」即可一键安装，无需额外配置。

Byted Supabase 是免费的吗？

是的，Byted Supabase 完全免费，采用 MIT-0 许可证，可自由下载、安装和使用。

Byted Supabase 支持哪些平台？

Byted Supabase 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（darwin, linux）。

谁开发了 Byted Supabase？

由 volcengine-skills（@volcengine-skills）开发并维护，当前版本 v1.0.0。

Byted Supabase