# @code-pushup/portal-client 中文文档

规范地址：https://npmcn.com/package/%40code-pushup/portal-client/

版本：0\.17\.0
npm 元数据更新时间：2026-02-02T09:38:18.604Z
中文译文更新时间：2026-11-10T06:12:39.887Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40code-pushup/portal-client
原文对照：https://npmcn.com/package/%40code-pushup/portal-client/?lang=original

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

- 包体积（解压后）：829 kB，12 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2023-09-27T13:39:24.313Z
- 最新版本发布：2026-02-02T09:38:18.137Z
- 近 30 天下载量：4400（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 1 个）

## 中文简介

有代码PushUp Portal类型定义的API客户端.

## 安装

```sh
npm install @code-pushup/portal-client
```

也可以使用：`pnpm add @code-pushup/portal-client`、`yarn add @code-pushup/portal-client`、`bun add @code-pushup/portal-client`

## README

# 代码 PushUp 门户网站客户端

有代码PushUp Portal类型定义的API客户端.

## 设置

```sh
npm install @code-pushup/portal-client
```

## 使用量

### 上传报告到门户网站

```ts
import { uploadReportToPortal } from '@code-pushup/portal-client';

// ...

const report = await uploadReportToPortal({
  server: '<GRAPHQL URL>',
  apiKey: process.env.CODE_PUSHUP_API_KEY,
  data: {
    organization: '<ORGANIZATION SLUG>',
    project: '<PROJECT SLUG>',
    commit: '<COMMIT SHA>',
    plugins: [
      // ...
    ],
    categories: [
      // ...
    ],
    // ...
  },
});
```

### 链接到门户比较页面

```ts
import { getPortalComparisonLink } from '@code-pushup/portal-client';

// ...

const url = await getPortalComparisonLink({
  server: '<GRAPHQL URL>',
  apiKey: process.env.CODE_PUSHUP_API_KEY,
  parameters: {
    organization: '<ORGANIZATION SLUG>',
    project: '<PROJECT SLUG>',
    before: '<COMMIT SHA_1>',
    after: '<COMMIT SHA_2>',
  },
});
```

### 从门户网站下载报告

```ts
import { downloadReportFromPortal } from '@code-pushup/portal-client';

// ...

const report = await downloadReportFromPortal({
  server: '<GRAPHQL URL>',
  apiKey: process.env.CODE_PUSHUP_API_KEY,
  parameters: {
    organization: '<ORGANIZATION SLUG>',
    project: '<PROJECT SLUG>',
    /* OPTIONAL: if commit not provided, finds latest report in default branch */
    // commit: '<COMMIT SHA>',
    /* OPTIONAL: opt in to including audit details (issues, trees, etc.), omitted by default to minimize payload */
    // withAuditDetails: true,
    /* OPTIONAL: maximum number of recent commits to search for latest report (ignored if commit set) */
    // maxCommits: 30,
  },
});
```

### 从 Portal 下载工程

```ts
import { downloadProjectsFromPortal } from '@code-pushup/portal-client';

// ...

const report = await downloadProjectsFromPortal({
  server: '<GRAPHQL URL>',
  apiKey: process.env.CODE_PUSHUP_API_KEY,
  parameters: {
    /* OPTIONAL: filter projects by organization */
    // organization: '<ORGANIZATION SLUG>',
    /* OPTIONAL: opt in to including each project's latest report */
    // withLatestReport: true,
    /* OPTIONAL: opt in to including audit details (ignored unless withLatestReport enabled) */
    // withAuditDetails: true,
    /* OPTIONAL: maximum number of recent commits to search for latest report (ignored unless withLatestReport enabled) */
    // maxCommits: 30,
  },
});
```

## 常见问题

### @code-pushup/portal-client 是什么？

有代码PushUp Portal类型定义的API客户端\.

### 如何安装 @code-pushup/portal-client？

在项目目录运行 npm install @code-pushup/portal-client，或使用 pnpm add / yarn add / bun add。

### @code-pushup/portal-client 支持 TypeScript 吗？

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

### @code-pushup/portal-client 支持 ESM 还是 CommonJS？

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

### @code-pushup/portal-client 可以商用吗？

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

### @code-pushup/portal-client 的下载量有多少？

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

### @code-pushup/portal-client 还在维护吗？

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