# @asiyst/cli 中文文档

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

版本：1\.1\.29
npm 元数据更新时间：2026-11-05T07:16:58.820Z
中文译文更新时间：2026-11-06T23:25:27.918Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：619 kB，5 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.18\.0
- 运行依赖：0 个
- 首次发布：2026-08-27T19:37:43.403Z
- 最新版本发布：2026-11-05T07:16:58.641Z
- 近 30 天下载量：2571（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：37（近 12 个月 37 个）

## 中文简介

连接本地网站项目到 Asiyst

## 安装

```sh
npm install @asiyst/cli
```

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

## README

# Asist CLI (英语)

这个 `asiyst` CLI 连接一个使用的网站 `@asiyst/sdk` 给一个Asiyst项目。 它不使相机,聊天机,仪表板,或分析UI.

## 安装和执行

### 全球安装

用于 `asiyst` 作为全局指令:

```sh
npm install --global @asiyst/cli
# or with Bun:
bun add -g @asiyst/cli

# Run:
asiyst --version
asiyst connect
```

### 项目-当地安装

要安装 `@asiyst/cli` 在特定项目内:

```sh
npm install --save-dev @asiyst/cli
# or with Bun:
bun add -d @asiyst/cli
```

支持的项目-当地引用:

-   **npx: (英语)**
    
    ```sh
    npx asiyst --version
    ```
    
-   **二进制 :**
    
    ```sh
    # macOS / Linux:
    ./node_modules/.bin/asiyst --version
    
    # Windows PowerShell:
    .\node_modules\.bin\asiyst --version
    
    # Windows CMD:
    node_modules\.bin\asiyst --version
    ```
    
-   **npm 脚本 :** 单位 `package.json`数字 :
    
    ```json
    "scripts": {
      "asiyst": "asiyst"
    }
    ```
    
    然后运行 :
    
    ```sh
    npm run asiyst -- status
    ```
    
-   **宾:**
    
    ```sh
    bunx asiyst --version
    ```
    

### 暂停执行

```sh
npx @asiyst/cli@latest
```

## 图标

Asiyst CLI的行为类似标准开发工具(如Git或Supabase CLI). 运行 `asiyst` 没有参数显示简洁的用法信息和退出。 每个操作直接被引用为 `asiyst <command>`。 。 。 .

使用 `asiyst connect --project-id <PROJECT_ID>` 或者说 `asiyst connect` 以启动认证和项目连接流程。 无 `--project-id`,认证流使用箭头键选择器来选择一个已存在的项目或通过安全的网络交接来创建新的项目,然后询问公共项目ID. CLI 从未提示用户ID, 也从未将认证的账户ID替换为项目ID .

标准命令是 `login`, (中文(简体) ), `logout`, (中文(简体) ), `connect`, (中文(简体) ), `disconnect`, (中文(简体) ), `status`, (中文(简体) ), `project`, (中文(简体) ), `avatar`, (中文(简体) ), `sdk`, (中文(简体) ), `verify`, (中文(简体) ), `doctor`, (中文(简体) ), `health`, (中文(简体) ), `config`, (中文(简体) ), `update`,以及 `restart`。 。 。 .

`asiyst restart` 请检查npm上最新的可用版本为CLI本身,比较语义版本,提示确认,安全地为活动环境安装更新(global/npx/local),验证已安装的版本,并自动重启CLI进程,同时保留所有已存在的证书并阻止重启循环.

`asiyst sdk` 显示状态 `@asiyst/sdk` 安装于当前工程(声明,安装,最新发布的npm版本). `asiyst sdk update` 检查 npm 最近的登记册 `@asiyst/sdk`,检测项目包管理器(`npm`, (中文(简体) ), `pnpm`, (中文(简体) ), `yarn`, (中文(简体) ), `bun`),提示确认,更新 `@asiyst/sdk` 在目标项目/工作空间中核查 `node_modules/@asiyst/sdk/package.json`。 。 。 .

`asiyst login` 在行动前用已认证的会话结束点检查现有的 CLI 会话 。 一个有效的会话在不打开浏览器的情况下被再使用;一个过期或被拒绝的会话通过浏览器的授权被清除并被替换. 如果无法达到API,则保留了现有的会话并登录无法验证的报告. 在没有有效会话的情况下,浏览器授权使用随机指定的本地host回调: CLI 注册回调并状态为 `POST /cli/auth/challenge`,打开返回的 Asiyst 授权 URL,验证一次性回调代码和状态,消耗挑战,并安全存储已核实的 CLI 会话. 仅在浏览器中的批准不被视为成功的登录. 登录时不请求用户ID,项目ID或API密钥.

```sh
asiyst connect --project-id K8mP2xQ7_vL4N9cR5T1zB6Y3
asiyst status
asiyst avatar import --avatar-id A7K9M2QX4P
asiyst disconnect
```

连接流验证了认证的账户,选择了24个字符项目ID,API密钥,并选择了10个字符AvatarID. API验证在连接被保存之前,账户,密钥,所选项目,和相机属于一起. 使用 `asiyst connect --project-id <PROJECT_ID> --avatar-id <AVATAR_ID>` 来绕过项目选择,并且以非交互方式提供两个ID;否则,CLI打开相关的仪表板页面并提示它们. 无效的项目ID可以被更正和再试,而过期的会话和未经授权的项目报告可采取行动的错误.

阿凡达核查采用批准的CLI合同. 目前Avatar导入在核实后被封禁,因为被批准的合同没有指定资产上传或文件引用机制. 当信息缺失时, CLI 不发送不完整的导入请求或修改网站文件 .

GitHub不属于这种CLI流量. GitHub寄存器的授权和知识库配置由Asiyst Web和Supabase管理. 网络仪表板可以将知识库和相机连接起来,但 `asiyst avatar import` 不请求 GitHub 证书、 下载仓库内容, 或在 GitHub 无法连接时屏蔽导入 。 网站只接收了SDK集成;而Avatar通过Asiyst后端检索所配置的知识.

分离是:

```text
GitHub repository
  -> Asiyst Knowledge Base
  -> Avatar knowledge configuration
  -> Asiyst backend
  -> @asiyst/sdk
  -> Website visitor
```

CLI 连接流量如下:

```text
Step 1: Authenticated account
  -> Step 2: Existing project selection or secure project creation / verification
  -> Step 3: Domain verification
  -> Step 4: API key verification
  -> Step 5: SDK install & setup
  -> Step 6: Avatar configuration & import
  -> Step 7: Knowledge source connection
  -> Final verification
```

交互式启动执行轻量级 npm 版本检查 。 如果新发布存在,则CLI只显示通知. 它从不自动安装或重启; 运行 `update` 并证实安装它。 全球设施得到更新。 对于 npx 引用, 最新的软件包会被下载和验证, 而不会更改网站项目 .

CLI用克南克语 `/api/v1/cli/...` aPI 密钥验证、所有者状态、外观验证和所描述的知识操作的路径 `docs/sdk-cli-contract.md`其他现有登录、登入、项目选择和诊断业务尚未与网上公布的合同进行比较。 密码,AI提供者密钥,Supabase密钥,以及私人API证书都决不能被放入URL或登录.

CLI 创建持续登入会话 `POST /cli/onboarding/session` 使用认证的 CLI 会话。 浏览器页面通过 `POST /cli/onboarding/handoff`,在请求信头中以此为参照进行了认证。 反应必须包含短寿命、单一用途 `handoffToken`; 只有该符号被放入 `https://asiyst.com/cli/onboarding/handoff?token=...`。网络交接端点必须验证并消耗该符号,为其已核实的用户建立现有的网页会话,并直接重定向到请求的页面(例如) `/project/new`)无通路 `/register`。无效或过期的会话必须返回 `SESSION_EXPIRED`,因此CLI可以要求用户重新连接而不是默默地重启注册.

生产 API 默认为 `https://nqhxpgsjofzqudyqkqib.supabase.co/functions/v1/api`。 。 。 .

## 合同和限制

当地批准的设计文件载于 `docs/ASIYST_API_Contract_v1_for_approval.md`;它还不是密码准确的网络发布合同. 在启动之前,将其与网上公布的合同和文件差异进行比较。 Avatar又需要Web团队指定实际上传或文件引用机制.

## 发展

```sh
npm run build
npm test
npm pack --dry-run
```

## 常见问题

### @asiyst/cli 是什么？

连接本地网站项目到 Asiyst

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

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

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

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

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

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

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

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

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

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

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

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

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

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