# @automate\.ax/client 中文文档

规范地址：https://npmcn.com/package/%40automate.ax/client/

版本：0\.165\.0
npm 元数据更新时间：2026-10-28T17:59:56.392Z
中文译文更新时间：2026-11-07T06:49:04.238Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40automate.ax/client
原文对照：https://npmcn.com/package/%40automate.ax/client/?lang=original
项目主页：https://docs.automate.ax/

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

- 包体积（解压后）：11.8 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：3 个
- 首次发布：2026-07-29T20:52:13.822Z
- 最新版本发布：2026-10-28T17:59:56.202Z
- 近 30 天下载量：2267（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：300（近 12 个月 300 个）

## 中文简介

Automate.ax API的Type安全客户端.

## 安装

```sh
npm install @automate.ax/client
```

也可以使用：`pnpm add @automate.ax/client`、`yarn add @automate.ax/client`、`bun add @automate.ax/client`

## README

# `@automate.ax/client`

公共Automate.ax管理API的Type安全客户端.

## 安装

```bash
bun add @automate.ax/client
```

## API 密钥

```ts
import { createAutomateClient } from "@automate.ax/client"

const client = createAutomateClient({
  apiKey: process.env.AUTOMATE_AX_API_KEY!,
})

const firstPage = await client.project.list({ limit: 25 })

for (const project of firstPage.items) {
  console.log(project.name)
}

if (firstPage.items[0]) {
  const automations = await client.automation.list({
    projectId: firstPage.items[0].id,
    limit: 25,
  })

  if (automations.items[0]) {
    const automation = await client.automation.get({
      automation: automations.items[0].id,
    })
    console.log(automation.triggers)
  }
}
```

清单程序返回 `{ items, pageInfo }`时 `pageInfo.hasMore` 是真的,通过 `pageInfo.nextCursor` 作为下一个请求 `cursor`。 。 。 .

钥匙是组织拥有的,寄入 `x-api-key` 头曰. 它不代表用户会话.

客户目标 `https://automate.ax/api/rpc`。嵌入式和本地呼叫器可以覆盖 `rpcUrl`,提供自定义 `fetch`,并按请求添加 `headers`数字 :

```ts
const client = createAutomateClient({
  apiKey: process.env.AUTOMATE_AX_API_KEY!,
  rpcUrl: "https://automate.test/api/rpc",
  headers: () => ({ "x-request-source": "local-test" }),
})
```

认证信头是附加信头后设置的,不能被覆盖 `headers`。 。 。 .

Automate.ax 动作运行时间使用相同的客户端 `runtimeToken`。该模式用于平台提供的活性执行符;它不是外部应用程序中组织API密钥的替换.

## 用户会话

用户范围程序,包括执行数据发现,使用登录用户的无记名会话:

```ts
import { createAutomateClient } from "@automate.ax/client"

const client = createAutomateClient({
  sessionToken: process.env.AUTOMATE_SESSION_TOKEN!,
})

const manifest = await client.executionData.manifest({
  projectId: "proj_01...",
  since: "2026-08-01T00:00:00Z",
})

console.log(manifest.consistency, manifest.resources)
```

信誉回调在每次请求之前都会得到评价,因此客户端可以使用刷新后发回的符号而无需再被创建. 供应的正中之一 `apiKey`, (中文(简体) ), `runtimeToken`,或 `sessionToken`。 。 。 .

## 常见问题

### @automate\.ax/client 是什么？

Automate\.ax API的Type安全客户端\.

### 如何安装 @automate\.ax/client？

在项目目录运行 npm install @automate\.ax/client，或使用 pnpm add / yarn add / bun add。

### @automate\.ax/client 支持 TypeScript 吗？

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

### @automate\.ax/client 支持 ESM 还是 CommonJS？

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

### @automate\.ax/client 需要什么版本的 Node\.js？

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

### @automate\.ax/client 可以商用吗？

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

### @automate\.ax/client 的下载量有多少？

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

### @automate\.ax/client 还在维护吗？

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