# @argos-ci/api-client 中文文档

规范地址：https://npmcn.com/package/%40argos-ci/api-client/

版本：0\.31\.3
npm 元数据更新时间：2026-10-16T12:48:05.825Z
中文译文更新时间：2026-11-06T18:31:05.313Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40argos-ci/api-client
原文对照：https://npmcn.com/package/%40argos-ci/api-client/?lang=original
项目主页：https://github.com/argos-ci/argos-javascript/blob/main/packages/api-client/README.md
源码仓库：https://github.com/argos-ci/argos-javascript

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

- 包体积（解压后）：302 kB，6 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：3 个
- 首次发布：2024-04-15T08:52:03.278Z
- 最新版本发布：2026-10-16T12:48:05.431Z
- 近 30 天下载量：1346552（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：63（近 12 个月 31 个）

## 中文简介

Argos API 客户端库.

## 安装

```sh
npm install @argos-ci/api-client
```

也可以使用：`pnpm add @argos-ci/api-client`、`yarn add @argos-ci/api-client`、`bun add @argos-ci/api-client`

## README

[![Argos](https://raw.githubusercontent.com/argos-ci/argos/main/resources/logos/github-readme-logo-light.png)](https://argos-ci.com/?utm_source=github&utm_medium=logo)

**团队和AI代理的开源视觉测试平台.**

# Argos API 客户端

输入客户端 [阿尔戈斯 API](https://api.argos-ci.com/v2/),在 [openapi 牵引](https://openapi-ts.dev/openapi-fetch/)。 。 。 .

[![npm version](https://img.shields.io/npm/v/@argos-ci/api-client.svg)](https://www.npmjs.com/package/@argos-ci/api-client) [![npm dm](https://img.shields.io/npm/dm/@argos-ci/api-client.svg)](https://www.npmjs.com/package/@argos-ci/api-client) [![npm dt](https://img.shields.io/npm/dt/@argos-ci/api-client.svg)](https://www.npmjs.com/package/@argos-ci/api-client)

## 安装

```sh
npm install @argos-ci/api-client
```

## 使用量

创建客户端并调用任何端点 。 请求和响应完全来自Argos OpenAPI 计划:

```ts
import { createClient } from "@argos-ci/api-client";

const client = createClient({
  authToken: process.env.ARGOS_TOKEN,
});

const { data, error } = await client.GET("/project");

if (error) {
  throw new Error(error.error);
}

console.log(data);
```

## 链接

-   [官方文件](https://argos-ci.com/docs)
-   [解析器](https://argos-ci.com/discord)

## 常见问题

### @argos-ci/api-client 是什么？

Argos API 客户端库\.

### 如何安装 @argos-ci/api-client？

在项目目录运行 npm install @argos-ci/api-client，或使用 pnpm add / yarn add / bun add。

### @argos-ci/api-client 支持 TypeScript 吗？

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

### @argos-ci/api-client 支持 ESM 还是 CommonJS？

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

### @argos-ci/api-client 需要什么版本的 Node\.js？

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

### @argos-ci/api-client 可以商用吗？

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

### @argos-ci/api-client 的下载量有多少？

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

### @argos-ci/api-client 还在维护吗？

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