# @epilot/auth 中文文档

规范地址：https://npmcn.com/package/%40epilot/auth/

版本：0\.8\.0
npm 元数据更新时间：2026-11-10T09:27:48.799Z
中文译文更新时间：2026-11-13T19:45:49.610Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40epilot/auth
原文对照：https://npmcn.com/package/%40epilot/auth/?lang=original
项目主页：https://github.com/epilot-dev/sdk-js/tree/main/packages/auth#readme
源码仓库：https://github.com/epilot-dev/sdk-js

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

- 包体积（解压后）：28 kB，21 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：axios ^1\.0\.0 \|\| \>=0\.25\.0 \<1\.0\.0
- 首次发布：2022-01-27T12:45:11.319Z
- 最新版本发布：2025-08-11T12:50:22.260Z
- 近 30 天下载量：7496（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 0 个）

## 中文简介

使用 epilot API 认证

## 安装

```sh
npm install @epilot/auth
```

也可以使用：`pnpm add @epilot/auth`、`yarn add @epilot/auth`、`bun add @epilot/auth`

## README

# @ epilot/ auth (帮助)

[![CI](https://github.com/epilot-dev/sdk-js/workflows/CI/badge.svg)](https://github.com/epilot-dev/sdk-js/actions?query=workflow%3ACI) [![npm version](https://img.shields.io/npm/v/@epilot/auth.svg)](https://www.npmjs.com/package/@epilot/auth) [![bundle size](https://img.shields.io/bundlephobia/minzip/@epilot/auth?label=gzip%20bundle)](https://bundlephobia.com/package/@epilot/auth) [![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/epilot-dev/sdk-js/blob/main/LICENSE)

使用 epilot API 认证

## 快速启动

```sh
npm install --save @epilot/auth
```

```typescript
import { authorizeWithToken } from '@epilot/auth';
import entityClient from '@epilot/entity-client';

authorizeWithToken(entityClient, '<my_access_token>');
```

## CLI 使用量

为了方便,您可以通过CLI快速获得测试的标志

```sh
$ npx @epilot/auth

? Email email@example.com
? Password [hidden]

# <access token printed here>
```

## 文档

[https://docs.epilot.io/docs/auth/ 认证](https://docs.epilot.io/docs/auth/authentication)

## 常见问题

### @epilot/auth 是什么？

使用 epilot API 认证

### 如何安装 @epilot/auth？

在项目目录运行 npm install @epilot/auth，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：axios（^1\.0\.0 \|\| \>=0\.25\.0 \<1\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 print-token，可以用 npx print-token 直接运行。

### @epilot/auth 支持 TypeScript 吗？

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

### @epilot/auth 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @epilot/auth 可以商用吗？

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

### @epilot/auth 的下载量有多少？

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

### @epilot/auth 还在维护吗？

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