# @byted-supabase/cli 中文文档

规范地址：https://npmcn.com/package/%40byted-supabase/cli/

版本：0\.1\.38
npm 元数据更新时间：2026-11-04T07:13:24.263Z
中文译文更新时间：2026-11-08T21:50:30.125Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40byted-supabase/cli
原文对照：https://npmcn.com/package/%40byted-supabase/cli/?lang=original
项目主页：https://github.com/volcengine/byted-supabase-cli
源码仓库：https://github.com/volcengine/byted-supabase-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.5 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2026-05-29T04:25:27.217Z
- 最新版本发布：2026-11-04T07:13:24.036Z
- 近 30 天下载量：9258（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：39（近 12 个月 39 个）

## 中文简介

Byted Supabase CLI 键盘

## 安装

```sh
npm install @byted-supabase/cli
```

也可以使用：`pnpm add @byted-supabase/cli`、`yarn add @byted-supabase/cli`、`bun add @byted-supabase/cli`

## README

# Byted Supabase CLI 键盘

[![npm version](https://img.shields.io/npm/v/%40byted-supabase%2Fcli.svg)](https://www.npmjs.com/package/@byted-supabase/cli) [![license](https://img.shields.io/npm/l/%40byted-supabase%2Fcli.svg)](https://npmcn.com/package/%40byted-supabase/cli/LICENSE) ![platforms](https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-lightgrey)

`byted-supabase-cli` 是Volcengine AI-native BaaS平台(Supabase版)的命令行工具. 它允许您管理工作空间,运行SQL,部署边缘函数,移动存储对象,主机静态前端,并生成TypeScript类型——全部来自一个终端命令.

## 为什么是CLI?

这是Byted/Volcengine 官方的分布 [基地CLI](https://github.com/supabase/cli),作为 npm 发布 [`@byted-supabase/cli`](https://www.npmjs.com/package/@byted-supabase/cli)。它使您从上游知道的命令形状能够应用,并以Volcengine操作的平台为目标,而不是supabase.com:

-   用您的认证 **Volcengine账户** 而不是supabasal.com. (原始内容存档于2017-09-28).
-   管理 **Volcengine Supabase 工作空间**,预览分支,计算,和终点.
-   添加上游没有的平台能力,如静态前端托管和一等支持AI编码代理.

如果你的后端运行在 Volcengine Supabase 上,这是 CLI 使用.

## 特征

-   **工作空间管理** - 创建、列出、开始/停止和配置工作空间(`projects`),预览分支(`branches`),计算(`computes`页:1`endpoints`)和网络限制`network-restrictions`) (中文(简体) ).
-   **数据库访问** 将 SQL 运行在一个链接的项目上 `db query`,拉出或倾出远程计数器(`db pull`, (中文(简体) ), `db dump`,获取连接字符串,并检查性能 `db advisors` 财务报告和审定财务报表 `inspect db`。 。 。 .
-   **边缘函数** - 脚手架(`functions new`,用于部署、下载和列出基于Deno的边缘函数 `secrets` 他们的配置.
-   **存储** 管理桶和物件 `storage ls / cp / mv / rm`,并公开提供桶 `seed buckets`。 。 。 .
-   **认证配置** 管理认证设置、钩子和第三方供应商 `auth`。 。 。 .
-   **类型生成** —— 说 `gen types` 直接从您的 Postgres 计划生成类型脚本( 或 Go / Swift) .
-   **前端托管** 在工作空间旁部署静态前端 `pages`。 。 。 .
-   **为人工智能代理建造** —— 说 `mcp serve` 在 stdio 上启动一个模式上下文协议服务器,以及 `skills install` 安装匹配 `byted-supabase` 代理技能,所以像克洛德代码这样的AI助手可以为你驱动平台.

## 开始

### 安装

引导设置在全球安装 CLI并匹配 `byted-supabase` 代理技能 :

```bash
npx @byted-supabase/cli@latest install
```

只安装 CLI 并获取 `byted-supabase-cli` 命令 :

```bash
npm install -g @byted-supabase/cli
```

或增加它作为一个项目 dev依赖:

```bash
npm i @byted-supabase/cli --save-dev
```

> npm在x86 64/arm64上为macOS / Linux / Windows安装匹配平台包. 没有邮站下载 .

### 认证

```bash
byted-supabase-cli login
```

这将打开 OAuth 登录您的 Volcengine 账户的浏览器 。 在无头机器上,使用 `byted-supabase-cli login --remote` 从另一个设备上签名。 在CI中,跳过 `login` 完全设置 `VOLCENGINE_ACCESS_KEY` 编号 : `VOLCENGINE_SECRET_KEY` (或使用) `configure set`相反。 见 [文件/日记/日记](https://npmcn.com/package/%40byted-supabase/cli/docs/supabase/login.md) 详细情况.

### 创建和链接工作空间

```bash
# Create a workspace on Volcengine Supabase
byted-supabase-cli projects create my-app

# Scaffold the local supabase/ directory and link it to the workspace
byted-supabase-cli init
byted-supabase-cli link --project-ref <workspace-id>
```

### 构建

```bash
# Run SQL against the linked workspace
byted-supabase-cli db query "select now()"

# Scaffold and deploy an Edge Function
byted-supabase-cli functions new hello
byted-supabase-cli functions deploy hello

# Generate TypeScript types from the database schema
byted-supabase-cli gen types --lang typescript
```

随时探索完整命令表面 :

```bash
byted-supabase-cli --help
```

### 更新

```bash
byted-supabase-cli update
```

## 文档

-   命令引用: 运行 `byted-supabase-cli --help` (或 `<command> --help`),对于权威列表——这种分布暴露出与上游Supabase CLI不同的指令表面
-   每个命令的扩展人页 : [文献/基础](https://npmcn.com/package/%40byted-supabase/cli/docs/supabase)
-   登录模式和非交互行为 : [文件/日记/日记](https://npmcn.com/package/%40byted-supabase/cli/docs/supabase/login.md)
-   用于构建自己工具的库使用示例 : [实例](https://npmcn.com/package/%40byted-supabase/cli/examples)

## 中断更改

我们对直接影响 CLI 命令、旗帜和配置的修改采用语义化版本.

然而,由于对其他服务图像的依赖,我们无法保证,schema migration, sent.sql,和所生成的种类总是能为同一个CLI主要版本工作. 如果你需要这种保证,我们鼓励你将特定版本的CLI装入包.json.

## 发展中国家

要运行源 :

```sh
# Go >= 1.25
go run . help
```

## 捐款

该项目不接受外部捐款或拉动请求。 欢迎虫子报告 [问题跟踪器](https://github.com/volcengine/byted-supabase-cli/issues)。 。 。 .

## 许可证

[麻省理工学院](https://npmcn.com/package/%40byted-supabase/cli/LICENSE)

## 常见问题

### @byted-supabase/cli 是什么？

Byted Supabase CLI 键盘

### 如何安装 @byted-supabase/cli？

在项目目录运行 npm install @byted-supabase/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 byted-supabase-cli，可以用 npx byted-supabase-cli 直接运行。

### @byted-supabase/cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/byted-supabase\_\_cli 是否存在。

### @byted-supabase/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @byted-supabase/cli 可以商用吗？

@byted-supabase/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @byted-supabase/cli 的下载量有多少？

根据 npm 官方下载统计，@byted-supabase/cli 在 2026/10/09 – 2026/11/07 这 30 天内被下载 9,258 次，日均约 309 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @byted-supabase/cli 还在维护吗？

最新版本 0\.1\.38 发布于 2026/11/04（4 天前）；至今共发布 39 个版本，其中过去 12 个月发布了 39 个；首次发布于 2026/05/29。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。