# @gaganref/confect-cli 中文文档

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

版本：10\.3\.1-fork\.45
npm 元数据更新时间：2026-11-01T02:29:10.461Z
中文译文更新时间：2026-11-01T05:24:42.910Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：918 kB，99 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=24
- 运行依赖：5 个
- peer 依赖：effect \>=4\.0\.4 \<4\.1\.0，@confect/core npm:@gaganref/confect-core@10\.3\.1-fork\.45，@confect/server npm:@gaganref/confect-server@10\.3\.1-fork\.45，@effect/platform-node-shared \>=4\.0\.4 \<4\.1\.0
- 首次发布：2026-10-18T12:34:05.827Z
- 最新版本发布：2026-11-01T02:29:10.101Z
- 已发布版本数：45（近 12 个月 45 个）

## 中文简介

用于编码和同步的开发人员工具

## 安装

```sh
npm install @gaganref/confect-cli
```

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

## README

# 西点🧁

这是一把叉子 [糖果](https://github.com/rjdellecese/confect)． 看到 [FORK.md](https://npmcn.com/package/%40gaganref/confect-cli/FORK.md) 用于构建、安装和维护，以及 [CHANGES.md](https://npmcn.com/package/%40gaganref/confect-cli/CHANGES.md) 对于fork的添加。

## 关于西点

Confect是一个深度集成了Effect和Convex的框架。它不仅仅是效果绑定！Confect允许您：

-   使用Effect模式定义凸数据库模式。
-   使用Effect的模式库编写凸函数参数并返回验证器。
-   使用Confect函数根据端到端富类型的Effect模式定义自动解码和编码数据，从客户端到函数到数据库（以及返回）。
-   向函数组或单个函数添加可重用的、类型安全的中间件，以提供Effect服务并在处理程序周围运行逻辑。
-   使用Effect模式在函数和中间件上声明类型错误，然后在每个调用站点处理解码后的错误。
-   使用Effect的原生HTTP API模块来定义HTTP API。
-   通过Effect服务访问凸平台功能。

想了解更多？读了 [文档](https://confect.dev/)！

## 常见问题

### @gaganref/confect-cli 是什么？

用于编码和同步的开发人员工具

### 如何安装 @gaganref/confect-cli？

在项目目录运行 npm install @gaganref/confect-cli，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：effect（\>=4\.0\.4 \<4\.1\.0）、@confect/core（npm:@gaganref/confect-core@10\.3\.1-fork\.45）、@confect/server（npm:@gaganref/confect-server@10\.3\.1-fork\.45）、@effect/platform-node-shared（\>=4\.0\.4 \<4\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 confect，可以用 npx confect 直接运行。

### @gaganref/confect-cli 支持 TypeScript 吗？

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

### @gaganref/confect-cli 支持 ESM 还是 CommonJS？

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

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

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

### @gaganref/confect-cli 可以商用吗？

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

### @gaganref/confect-cli 还在维护吗？

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