# @edgespark/cli 中文文档

规范地址：https://npmcn.com/package/%40edgespark/cli/

版本：0\.0\.25
npm 元数据更新时间：2026-10-26T11:09:36.914Z
中文译文更新时间：2026-11-14T08:46:16.993Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40edgespark/cli
原文对照：https://npmcn.com/package/%40edgespark/cli/?lang=original
项目主页：https://github.com/ArcoCodes/edge-spark#readme
源码仓库：https://github.com/ArcoCodes/edge-spark

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

- 包体积（解压后）：5.3 MB，40 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22\.0\.0
- 运行依赖：12 个
- 首次发布：2025-12-08T06:47:01.407Z
- 最新版本发布：2026-10-26T11:09:36.610Z
- 近 30 天下载量：2093（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：59（近 12 个月 59 个）

## 中文简介

EdgeSpark CLI - 创建和管理您的EdgeSpark项目

## 安装

```sh
npm install @edgespark/cli
```

也可以使用：`pnpm add @edgespark/cli`、`yarn add @edgespark/cli`、`bun add @edgespark/cli`

## README

# @ edgespark/ cli

EdgeSpark CLI - 创建和管理您的EdgeSpark项目.

## 安装

```bash
npm install -g @edgespark/cli
```

## 使用量

### 启动新项目

```bash
# With specific AI agent (--agent is required)
edgespark init my-project --agent claude    # Creates CLAUDE.md
edgespark init my-project --agent gemini    # Creates GEMINI.md
edgespark init my-project --agent codex     # Creates AGENTS.md

```

**代理选项 :** `claude`, (中文(简体) ), `codex`, (中文(简体) ), `gemini` (其他则回到 `AGENTS.md`(中文(简体) )

### 从 EdgeSpark 平台拉出

```bash
edgespark pull
```

提取您 EdgeSpark 工程的最新生成的文物 :

-   计划文件输入 `src/__generated__/`
-   输入 SDK 类型 `src/__generated__/edgespark.d.ts` 财务报告和审定财务报表 `src/__generated__/server-types.d.ts`

导入生成项目中的边界 :

-   `src/defs/**` 可能从 `@sdk/server-types`
-   `src/defs/**` 不得从 `"edgespark"`
-   路由和应用程序代码应导入运行时间 SDK 值 `"edgespark"`

你也可以有选择地拉:

```bash
edgespark pull schema
edgespark pull types
```

### 管理自定义域

自定义域仅为生产。 不支持显示自定义域 .

```bash
# Start domain setup and get the required DNS records
edgespark domain add app.example.com

# Poll verification and activate routing once DNS is in place
edgespark domain verify app.example.com

# Inspect current status, DNS records, and any warnings
edgespark domain status app.example.com

# List all custom domains for the current project
edgespark domain list

# Remove a custom domain and release the claim
edgespark domain remove app.example.com
```

`domain add` 财务报告和审定财务报表 `domain status` 总是返回设置所需的手工 DNS 记录 .  
当EdgeSpark可以构建一个被支持的域连接设置 URL时,它作为方便被返回,但人工DNS仍然是真理的来源.

### 帮助

```bash
# General help
edgespark --help

# Command-specific help
edgespark init --help
edgespark pull --help
```

## 图标

| 命令 | 说明 |
| --- | --- |
| `edgespark init <name> --agent <name>` | 启动一个新的 EdgeSpark 项目 |
| `edgespark db generate` | 生成来自 `src/defs/db_schema.ts` |
| `edgespark db migrate` | 将待处理的迁移到项目数据库 |
| `edgespark db studio` | 打开项目数据库的数据库浏览器 |
| `edgespark db check` | 验证当地移徙的一致性 |
| `edgespark db sql` | 在项目数据库中运行 SQL |
| `edgespark domain add <hostname>` | 启动自定义域设置并打印 DNS 记录 |
| `edgespark domain verify <hostname>` | 检查自定义域是否活动 |
| `edgespark domain status <hostname>` | 显示当前自定义域名状态和 DNS 指导 |
| `edgespark domain list` | 列出当前工程的自定义域 |
| `edgespark domain remove <hostname>` | 从工程中删除自定义域 |
| `edgespark pull` | 从 EdgeSpark 调取计划和类型 |
| `edgespark pull schema` | 拉动平台管理系统 DB schema |
| `edgespark pull types` | 拉出生成的 SDK 类型声明 |

## 项目结构

运行后 `edgespark init`,您的项目将:

```
my-project/
├── src/
│   ├── index.ts              # Your API routes (Hono)
│   ├── __generated__/        # Generated artifacts (pulled from platform)
│   │   ├── index.ts          # Barrel exports
│   │   ├── sys_schema.ts     # System database schema (Drizzle ORM)
│   │   ├── sys_relations.ts  # System relation definitions (if any)
│   │   ├── storage_schema.ts # Storage bucket definitions
│   │   ├── edgespark.d.ts    # What user code can import from "edgespark" and "edgespark/*"
│   │   └── server-types.d.ts # Shared SDK type definitions
├── edgespark.toml            # Project configuration
├── package.json
├── tsconfig.json
└── AGENTS.md                 # AI coding agent instructions (or CLAUDE.md / GEMINI.md)
```

## 发展

```bash
npm run build:dev   # tsc (for development/tests)
npm run dev         # tsc --watch
npm test            # run tests
npm run link        # build bundle + npm link for local testing
```

## 出版

`prepublishOnly` 在发布前自动运行 esbuild + 复制模板.

### 1\. 贝塔发布

```bash
npm version <version>-beta.0       # first beta for a new version (manual)
npm publish --tag beta             # publish to "beta" tag (latest untouched)
```

### 2\. β上的斜体

```bash
npm version prerelease             # auto-bumps beta.0 → beta.1 → beta.2
npm publish --tag beta
```

### 3\. 测试β

```bash
npm install -g @edgespark/cli@beta # install globally
edgespark --version                # verify
npx @edgespark/cli@beta --version  # or test without global install
```

### 4\. 毕业释放

```bash
npm version patch                  # 0.0.X-beta.N → 0.0.X (clean version)
npm publish                        # publishes to "latest" tag
```

### 版本命令欺骗工作表

| 命令 | 示例 |
| --- | --- |
| `npm version <version>-beta.0` | 第一个β( 人工) |
| `npm version prerelease` | `beta.0` → `beta.1` |
| `npm version patch` | `0.0.10-beta.2` → `0.0.10` |
| `npm version minor` | → `0.1.0` |
| `npm version major` | → `1.0.0` |

## 许可证

麻省理工学院

## 常见问题

### @edgespark/cli 是什么？

EdgeSpark CLI - 创建和管理您的EdgeSpark项目

### 如何安装 @edgespark/cli？

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

### @edgespark/cli 支持 TypeScript 吗？

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

### @edgespark/cli 支持 ESM 还是 CommonJS？

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

### @edgespark/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @edgespark/cli 可以商用吗？

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

### @edgespark/cli 的下载量有多少？

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

### @edgespark/cli 还在维护吗？

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