# @cuttlely/chat 中文文档

规范地址：https://npmcn.com/package/%40cuttlely/chat/

版本：1\.7\.2
npm 元数据更新时间：2026-11-10T17:30:26.561Z
中文译文更新时间：2026-11-11T05:30:40.100Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：170 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-10-11T05:12:45.222Z
- 最新版本发布：2026-11-10T17:30:26.423Z
- 近 30 天下载量：4681（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 29 个）

## 中文简介

用于应用程序的可嵌入的快捷聊天部件

## 安装

```sh
npm install @cuttlely/chat
```

也可以使用：`pnpm add @cuttlely/chat`、`yarn add @cuttlely/chat`、`bun add @cuttlely/chat`

## README

# @ cuttlely/聊天时

1.7.2包与1.7.2服务器相匹配. 仍然适用1.7.0安全例外升级要求:在服务器升级前备份数据库,加密密钥和设置. 读取 [升级警告](https://cuttlely.com/docs/upgrading/)。只有指定的实例运算符可以更改服务设置,执行则默认停止。 在主机仪表板上读取主机-日志证明或Docker/Confose日志. 服务器升级需要 [操作员登入和回收](https://cuttlely.com/docs/how-to/instance-operator/);只有经核实的主机绑定外公;遗留在服务器设置中安装有主机-日志代码的主张. 常规操作员生命周期在面板中;CLI是紧急恢复. 公共嵌入物仍与私人服务器侧API密钥相分离. 永远不要让一个特权持有人在浏览器嵌入配置中.

聊天流程或代理流程的聊天部件 。 它使阴影根内部,流出答案, 并且只与你的可爱的服务器交谈.

您的服务器也服务于此架构 `/embed/chat.js`,使部件保持与服务器相同的版本。 当应用程序导入部件时安装此软件包 .

```bash
npm install @cuttlely/chat
```

## 脚本标签

服务于你的可爱服务器。 脚本使用自己的地址作为服务器.

```html
<script src="https://your-cuttlely.example.com/embed/chat.js" data-flow-id="YOUR_CHATFLOW_ID" defer></script>
```

标签所在的全页聊天:

```html
<cuttlely-chat
    flow-id="YOUR_CHATFLOW_ID"
    mode="page"
    api-host="https://your-cuttlely.example.com"
    style="display:block;height:100vh"
></cuttlely-chat>
<script src="https://your-cuttlely.example.com/embed/chat.js" defer></script>
```

软件包文件是 `dist/chat.js` (单位:千美元)`@cuttlely/chat/chat.js`) (中文(简体) ). 当文件未从您的 Cuttle 服务器上装入时, 设置 `data-api-host` 到服务器.

| 属性 | 数值 | 默认 |
| --- | --- | --- |
| `flow-id` 编号 : `data-flow-id` | 聊天流程或代理流程 | 所需经费 |
| `mode` 编号 : `data-mode` | `bubble`, (中文(简体) ), `page` | `bubble` |
| `theme` 编号 : `data-theme` | `auto`, (中文(简体) ), `light`, (中文(简体) ), `dark` | `auto` |
| `api-host` 编号 : `data-api-host` | 剪切服务器 URL | 脚本自己的服务器 |
| `open` 编号 : `data-open="true"` | 开始打开 | 关闭 |

## 无害环境管理

```js
import { mount } from '@cuttlely/chat'

const chat = mount(document.querySelector('#chat'), {
    flowId: 'YOUR_CHATFLOW_ID',
    apiHost: 'https://your-cuttlely.example.com',
    mode: 'page',
    theme: 'auto'
})

chat.open()
chat.close()
chat.reset()
chat.destroy()
```

`flowId` 需要时间. `mode` 实值 `bubble` 或者说 `page`。 。 。 . `theme` 实值 `auto`, (中文(简体) ), `light` 或者说 `dark`。 。 。 . `apiHost` 这是你的可爱的服务器。 脚本标签 `window.cuttlelyChat.mount(element, options)` 选择相同.

在嵌入前让聊天流公开. 需要 API 密钥的流程显示“ 此聊天是私人的或需要密钥 ” 。 流外允许域的站点显示"此聊天在此站点上无法使用".

## 开发

```bash
pnpm --dir packages/chat-widget build   # dist/chat.js and dist/index.mjs
pnpm --dir packages/chat-widget test
```

`dist/chat.js` 是服务器服务的脚本 . `dist/index.mjs` 是ES模块. `index.d.ts` 是类型声明.

## 常见问题

### @cuttlely/chat 是什么？

用于应用程序的可嵌入的快捷聊天部件

### 如何安装 @cuttlely/chat？

在项目目录运行 npm install @cuttlely/chat，或使用 pnpm add / yarn add / bun add。

### @cuttlely/chat 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cuttlely/chat 支持 ESM 还是 CommonJS？

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

### @cuttlely/chat 可以商用吗？

@cuttlely/chat 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cuttlely/chat 的下载量有多少？

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

### @cuttlely/chat 还在维护吗？

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