# @artus-cli/plugin-help 中文文档

规范地址：https://npmcn.com/package/%40artus-cli/plugin-help/

版本：1\.1\.0
npm 元数据更新时间：2024-02-20T03:48:44.111Z
中文译文更新时间：2026-11-06T21:25:22.074Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40artus-cli/plugin-help
原文对照：https://npmcn.com/package/%40artus-cli/plugin-help/?lang=original
项目主页：https://github.com/artus-cli/plugin-help#readme
源码仓库：https://github.com/artus-cli/plugin-help

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

- 包体积（解压后）：10.1 kB，10 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2022-12-21T11:20:21.559Z
- 最新版本发布：2023-03-29T03:12:38.960Z
- 近 30 天下载量：14435（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

显示@ artus- cli 的帮助信息

## 安装

```sh
npm install @artus-cli/plugin-help
```

也可以使用：`pnpm add @artus-cli/plugin-help`、`yarn add @artus-cli/plugin-help`、`bun add @artus-cli/plugin-help`

## README

# @ artus- cli/ 插件帮助

用于在 artus- cli 中显示帮助信息的内置插件

[![NPM version](https://img.shields.io/npm/v/@artus-cli/plugin-help.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-help) [![NPM quality](https://img.shields.io/npms-io/final-score/@artus-cli/plugin-help.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-help) [![NPM download](https://img.shields.io/npm/dm/@artus-cli/plugin-help.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-help) [![Continuous Integration](https://github.com/artus-cli/plugin-help/actions/workflows/ci.yml/badge.svg)](https://github.com/artus-cli/plugin-help/actions/workflows/ci.yml) [![Test coverage](https://img.shields.io/codecov/c/github/artus-cli/plugin-help.svg?style=flat-square)](https://codecov.io/gh/artus-cli/plugin-help) [![Oss Insight Analytics](https://img.shields.io/badge/OssInsight-artus--cli%2Fartus--cli-blue.svg?style=flat-square)](https://ossinsight.io/analyze/artus-cli/plugin-help)

## 安装

```sh
$ npm i @artus-cli/plugin-help
```

## 使用量

```ts
// plugin.ts

export default {
  help: {
    enable: true,
    package: '@artus-cli/plugin-help',
  },
};
```

## 捐款

```sh
$ npm test
$ npm run cov
```

## 常见问题

### @artus-cli/plugin-help 是什么？

显示@ artus- cli 的帮助信息

### 如何安装 @artus-cli/plugin-help？

在项目目录运行 npm install @artus-cli/plugin-help，或使用 pnpm add / yarn add / bun add。

### @artus-cli/plugin-help 支持 TypeScript 吗？

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

### @artus-cli/plugin-help 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @artus-cli/plugin-help 可以商用吗？

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

### @artus-cli/plugin-help 的下载量有多少？

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

### @artus-cli/plugin-help 还在维护吗？

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