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

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

版本：1\.0\.1
npm 元数据更新时间：2024-04-29T04:08:23.339Z
中文译文更新时间：2026-11-06T21:25:26.929Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：79.4 kB，42 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：13 个
- 首次发布：2022-12-12T09:40:38.715Z
- 最新版本发布：2024-04-29T04:08:23.109Z
- 近 30 天下载量：13817（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：27（近 12 个月 0 个）

## 中文简介

具有现代特色的CLI框架

## 安装

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

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

## README

# @ artus- cli/ artus- cli

![artus-cli](https://socialify.git.ci/artus-cli/artus-cli/image?description=1&descriptionEditable=__________%20%20CLI%20framework%20with%20modern%20features%20%20__________%20%20%20%20%20%20%20%20%20%20%20%20%20%20%F0%9F%92%AA%20Powerful%20%2B%20%F0%9F%9A%80%20Modern%20%2B%20%F0%9F%8E%A2%20Customizable&font=Source%20Code%20Pro&language=1&name=1&owner=1&pattern=Circuit%20Board&theme=Dark)

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

`artus-cli` 旨在提供现代指令行应用框架.

-   **强大的**,由 [艺术](https://github.com/artusjs)。 。 。 .
-   **现代**, TypeScript 和 IOC 已准备好 .
-   **可自定义**,命令继承,并支持插件和框架(把它包装为上层 CLI).
-   **社区**,享受生态友好,使用相同的插件与您的 artusjs 网络应用.

## 怎么样

```ts
import { DefineCommand, Option, Command } from '@artus-cli/artus-cli';

@DefineCommand({
  command: 'dev',
  description: 'Run the development server',
  alias: [ 'd' ],
})
export class DevCommand extends Command {
  @Option({
    alias: 'p',
    default: 3000,
    description: 'server port',
  })
  port: number;

  async run() {
    console.info('port: %s', this.port);
  }
}
```

运行它与 :

```bash
$ my-cli dev --port 8080
```

## 文档

[https://artus-cli.github.io (中文(简体) )](https://artus-cli.github.io/)

## 常见问题

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

具有现代特色的CLI框架

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

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

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

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

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

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

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

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

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

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

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

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