# @asiyst/sdk 中文文档

规范地址：https://npmcn.com/package/%40asiyst/sdk/

版本：0\.1\.31
npm 元数据更新时间：2026-11-05T07:14:47.477Z
中文译文更新时间：2026-11-08T07:21:57.221Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40asiyst/sdk
原文对照：https://npmcn.com/package/%40asiyst/sdk/?lang=original
项目主页：https://asiyst.com/
源码仓库：https://github.com/asiyst-ai/Asiyst-SDK-CLI

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

- 包体积（解压后）：1.3 MB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.18\.0
- 运行依赖：1 个
- 首次发布：2026-08-27T19:40:23.409Z
- 最新版本发布：2026-11-05T07:14:47.301Z
- 近 30 天下载量：1875（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 24 个）

## 中文简介

连接网站到 Asiyst Cloud 的客户端运行时间

## 安装

```sh
npm install @asiyst/sdk
```

也可以使用：`pnpm add @asiyst/sdk`、`yarn add @asiyst/sdk`、`bun add @asiyst/sdk`

## README

# @ asiyst/ sdk

客户端运行时间将一个网站连接到Asiyst Cloud.

此软件包不包含模型密钥,数据库证书,也不包含其他服务器机密. 以 `projectId` 财务报告和审定财务报表 `publicKey` 只有这个 这些价值是公共项目证书,而不是秘密.

## 安装

```bash
npm install @asiyst/sdk
```

然后连接工程 :

```bash
npx @asiyst/cli init
```

`asiyst init` 打开 [https://sayst.com (中文(简体) )](https://asiyst.com/) 这样您就可以创建一个项目并复制证书。 神通外观和行为都住在Asiyst Cloud,这样你就可以在不重新部署网站的情况下改变它们.

## 使用量

需要项目ID。 该值必须是目标Asiyst项目的公共项目ID,而不是开发商账户用户ID,而不是内部Supabase UUID.

```ts
import { Asiyst } from "@asiyst/sdk";

await Asiyst.init({
  projectId: "<PUBLIC_PROJECT_ID>",
  publicKey: "<PUBLIC_KEY>",
  avatarId: "<PUBLIC_AVATAR_ID>",
});
Asiyst.open();
```

不传递密钥为 API `publicKey` 或省略 `projectId`。 。 。 .

`avatarId` 是一个公开的标识,而不是授权证书。 服务器仍然对项目和安装授权具有权威性.

知识源,包括可选的GitHub寄存器,在Asiyst Web中配置. SDK不接受GitHub证书,也不将"知识库"内容复制到网站上. 它初始化已验证的项目/avatar,并通过Asiyst后端获取授权的知识.

```ts
await Asiyst.init({
  publicKey: "<PUBLIC_KEY>",
});
// throws: Asiyst SDK: projectId is required.
```

标记重要控件, 使助手可以在布局上找到它们 :

```html
<button data-asiyst="pricing">Pricing</button>
<button
  data-asiyst="checkout"
  data-asiyst-description="Proceed to checkout"
>
  Checkout
</button>
```

API的生产基础是 `https://nqhxpgsjofzqudyqkqib.supabase.co/functions/v1/api`。默认情况下使用,只能通过 `apiBaseUrl` 用于控制下的非生产部署.

如果运行时配置不可用, SDK 保留其本地或符合条件的缓存回落配置 . `getConnectionStatus()` 单独报告运行时间核查。 访问者聊天需要经过核实的安装和运行时的代号. 云任务规划,工作流程,遥测,和网站地图上传等不属于当前批准的合同内容,不予发送.

## 文档

-   结构 : `docs/ARCHITECTURE.md`
-   API 和活动 : `docs/API.md`
-   警卫: `docs/SECURITY.md`
-   运行时间合同 : `docs/sdk-cli-contract.md`
-   运行时间细节 : `docs/sdk-runtime.md`
-   安装 : `docs/sdk-installation.md`
-   解决问题: `docs/TROUBLESHOOTING.md`

## 常见问题

### @asiyst/sdk 是什么？

连接网站到 Asiyst Cloud 的客户端运行时间

### 如何安装 @asiyst/sdk？

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

### @asiyst/sdk 支持 TypeScript 吗？

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

### @asiyst/sdk 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @asiyst/sdk 需要什么版本的 Node\.js？

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

### @asiyst/sdk 可以商用吗？

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

### @asiyst/sdk 的下载量有多少？

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

### @asiyst/sdk 还在维护吗？

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