# @compas/cli 中文文档

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

版本：0\.28\.0
npm 元数据更新时间：2026-10-02T09:03:35.131Z
中文译文更新时间：2026-11-10T13:35:40.354Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：250 kB，78 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：5 个
- 首次发布：2020-12-08T18:40:12.838Z
- 最新版本发布：2026-10-02T09:03:34.842Z
- 近 30 天下载量：3371（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：226（近 12 个月 13 个）

## 中文简介

包含公用设施和简单脚本运行器的 CLI

## 安装

```sh
npm install @compas/cli
```

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

## README

# 翻译:

 [![Install size](https://packagephobia.com/badge?p=@compas/cli)](https://packagephobia.com/result?p=@compas/cli)[![CI status badge](https://github.com/compasjs/compas/actions/workflows/checks.yml/badge.svg) ](https://github.com/compasjs/compas/actions/workflows/checks.yml)[![Codecov status](https://codecov.io/gh/compasjs/compas/branch/main/graph/badge.svg?token=81D84CV04U)](https://codecov.io/gh/compasjs/compas)

* * *

CLI 帮助您的本地开发环境,测试和更多。 拿着 看这个 [文档](https://compasjs.com/getting-started.html)。 。 。 .

## 维护模式

Compas处于维护状态. 软件包将保留给 可预见的未来。 可能增加一些新功能,但有些功能也将删除 有利于其他生态系统可用的图书馆。 请不要开始新的项目 使用Compas.

## 参考文献

全文请参看 [文档](https://compasjs.com/references/cli.html)。下面是简短的 引用,通过 `compas help`。 。 。 .

```
Usage: compas COMMAND

The Compas CLI

Unified backend tooling.

Examples:
- compas docker up
- compas lint --jsdoc
- compas visualise erd --generated-directory ./src/generated

References:
- Docs: https://compasjs.com
- Source: https://github.com/compasjs/compas
- Issues: https://github.com/compasjs/compas/issues


Commands:
  check-env          Various checks helping with a better Compas experience.
  code-mod           Execute code-mods to help migrating to new Compas versions.
  completions        Configure shell auto-complete for this CLI.
  docker             Manage common docker components.
  help               Display help for any of the available commands.
  init               Init various files in the current project.
  lint               Lint all project files.
  migrate            Run PostgreSQL migrations via the @compas/store migration system.
  run                Run arbitrary JavaScript files, scripts defined in the package.json and scripts located in the scripts directory.
  test               Run all tests in your project.
  version            Print the installed Compas version and exit
  visualise          Visualise various code-generated structures.
  watch              Run the command, restarting it when file changes happen.

Flags:
  -h, --help     Display information about the current command. (boolean)

Run 'compas help COMMAND' for more information of a specific sub command.
```

## 常见问题

### @compas/cli 是什么？

包含公用设施和简单脚本运行器的 CLI

### 如何安装 @compas/cli？

在项目目录运行 npm install @compas/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 compas，可以用 npx compas 直接运行。

### @compas/cli 支持 TypeScript 吗？

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

### @compas/cli 支持 ESM 还是 CommonJS？

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

### @compas/cli 需要什么版本的 Node\.js？

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

### @compas/cli 可以商用吗？

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

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

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

### @compas/cli 还在维护吗？

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