# @gutenye/commander-completion-carapace 中文文档

规范地址：https://npmcn.com/package/%40gutenye/commander-completion-carapace/

版本：1\.0\.9
npm 元数据更新时间：2025-07-25T03:06:52.226Z
中文译文更新时间：2026-11-17T04:04:09.616Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：52.4 kB，49 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：3 个
- peer 依赖：commander ^13 \|\| ^12\.1\.0
- 首次发布：2024-12-26T09:29:18.088Z
- 最新版本发布：2025-07-25T03:06:52.033Z
- 近 30 天下载量：208450（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

使用 Carapace 向您的 CLI 指令员添加智能自动完整支持。 支持Bash、Zsh、Fish、Nushell等

## 安装

```sh
npm install @gutenye/commander-completion-carapace
```

也可以使用：`pnpm add @gutenye/commander-completion-carapace`、`yarn add @gutenye/commander-completion-carapace`、`bun add @gutenye/commander-completion-carapace`

## README

# 指挥官完成卡拉帕斯

[![Stars](https://img.shields.io/github/stars/gutenye/commander-completion-carapace?style=social)](https://github.com/gutenye/commander-completion-carapace) [![NPM Version](https://img.shields.io/npm/v/@gutenye/commander-completion-carapace)](https://www.npmjs.com/package/@gutenye/commander-completion-carapace) [![License](https://img.shields.io/github/license/gutenye/commander-completion-carapace?color=blue)](https://github.com/gutenye/commander-completion-carapace/blob/main/LICENSE) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-blue)](https://github.com/gutenye/commander-completion-carapace#-contribute)

将智能自动完整支持添加到您的 [指挥官.js](https://github.com/tj/commander.js) 使用 CLI 应用程序 [卡拉帕斯语Name](https://github.com/carapace-sh/carapace-bin)。 。 。 . 它与广泛的外壳相配合,使你的CLI工具更加直观和方便用户.

**通过主演这个项目并跟随作者,显示你的QQ和支持, [古腾叶](https://github.com/gutenye)来啊!**

[![screenrecording](https://asciinema.org/a/GyJv0xAaZqGp9k1TFNcnaiB9y.svg)](https://asciinema.org/a/GyJv0xAaZqGp9k1TFNcnaiB9y)

## \* 特性

-   ⌘ **多个贝壳支持**:与巴什,兹什,菲什,努谢尔等合作.
-   🚄 **快速补全**: 经验即时完成,无延误.
-   🔗 **Carapace 一体化组织**:解锁卡拉帕斯所有强大的特征,包括高级外壳完成.
-   🧑‍💻 **无力融合**: 轻松地将完成支持添加到你的指挥官.js基于CLI的应用上.

## 开始

### 1️⃣ 安装

首先,确保安装Carapace,因为它赋予完成功能:

```sh
bun add @gutenye/commander-completion-carapace commander
```

### 2+++ 写完成代码

现在,通过添加以下代码,将完成支持整合到您的Command.js应用程序中:

```ts
import { program, Option } from '@gutenye/commander-completion-carapace'

program
  .name('hello')
  .enableCompletion()

program.command('cmd1 [...files]')
  .description('Description')
  .option('--option1', 'Description')
  .completion({   // pass to carapace 
    positonalany: ['$files'] // dynamic completion
  })
  .action(() => {})

await program.installCompletion() // Creates hello.yaml Carapace spec file

program.parse()
```

### 3️⃣ 使用补全

```sh
hello      # Will create the Carapace spec file the first time it runs
hello<Tab> # Press Tab to see completions for commands and options
```

## \* 贡献

我们欢迎捐款! 无论是错误报告、专题建议还是调取请求.

**如何贡献:**

1.  叉存储器
2.  在 Github 上打开拉出请求

* * *

谢谢你使用指挥官完成卡拉帕斯! 如果你觉得有帮助,请在GitHub上 做项目。 如果你遇到任何问题,请随意向Github报告一个问题.

**特别感谢所有捐助者:**

[![](https://contrib.rocks/image?repo=gutenye/commander-completion-carapace)](https://github.com/gutenye/commander-completion-carapace/graphs/contributors)

[回到顶端](https://npmcn.com/package/%40gutenye/commander-completion-carapace/#readme-readme)

## 常见问题

### @gutenye/commander-completion-carapace 是什么？

使用 Carapace 向您的 CLI 指令员添加智能自动完整支持。 支持Bash、Zsh、Fish、Nushell等

### 如何安装 @gutenye/commander-completion-carapace？

在项目目录运行 npm install @gutenye/commander-completion-carapace，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：commander（^13 \|\| ^12\.1\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gutenye/commander-completion-carapace 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/gutenye\_\_commander-completion-carapace 是否存在。

### @gutenye/commander-completion-carapace 支持 ESM 还是 CommonJS？

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

### @gutenye/commander-completion-carapace 可以商用吗？

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

### @gutenye/commander-completion-carapace 的下载量有多少？

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

### @gutenye/commander-completion-carapace 还在维护吗？

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

