# @feature-sliced/cli 中文文档

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

版本：1\.0\.0
npm 元数据更新时间：2026-06-07T19:27:20.387Z
中文译文更新时间：2026-11-14T12:56:16.813Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：68.6 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：4 个
- 首次发布：2023-12-02T23:48:15.538Z
- 最新版本发布：2024-01-14T22:24:19.833Z
- 近 30 天下载量：4788（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

能够快速地从Feature-Sliced Design中生成地层,切片和片段.

## 安装

```sh
npm install @feature-sliced/cli
```

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

## README

# @ feature- sliced/ cli (英语)

[![npm version](https://img.shields.io/npm/v/@feature-sliced/cli)](https://www.npmjs.com/package/@feature-sliced/cli) [![Static checks and tests](https://github.com/feature-sliced/cli/actions/workflows/check.yaml/badge.svg)](https://github.com/feature-sliced/cli/actions/workflows/check.yaml)

从中快速生成地层、切片和片段的工具 [特色设计](https://feature-sliced.design/)。 。 。 .

## 安装

```bash
npm add -g @feature-sliced/cli
```

这将创建一个全局二进制 `fsd`。也可以在本地安装此 CLI,但您需要使用 `npx` 运行它.

## 使用量

生成实体层 `client` 包含索引文件和两个片段的切片, `ui` 财务报告和审定财务报表 `api`数字 :

```bash
fsd entities client --segments ui api
```

或者,简而言之:

```bash
fsd e client -s ui,api
```

如果您的工程中至少有一块, CLI 将会知道在哪里生成 。 否则,它将会在当前文件夹中生成,或者您可以指定自己与该文件夹的位置 `--root` 或者说 `-r` 选项.

其他例子

-   用一个 `bottom-bar` 具有索引文件和片段的切片 `ui` 财务报告和审定财务报表 `api` 输入 `src/` 文件夹 :
    
    ```bash
    fsd w bottom-bar -s ui api -r src
    fsd widget bottom-bar -s ui,api -r src
    fsd widgets bottom-bar --segments ui,api -r src
    ```
    
    生产:
    
    -   `src/widgets/bottom-bar/index.(js|ts)` (取决于您的项目)
    -   `src/widgets/bottom-bar/ui/`
    -   `src/widgets/bottom-bar/api/`
-   用切片生成地物层 `employee/employee-record` 在切片组内 `employee`数字 :
    
    ```bash
    fsd f employee/employee-record
    fsd feat employee/employee-record
    ```
    
    在检测到的 FSD root \[^1\] 或当前文件夹中,生成:
    
    -   `features/employee/employee-record/index.(js|ts)` (取决于您的项目)
-   生成实体层 `user` 切入内侧 `src/lib` 文件夹,必要时创建文件夹 :
    
    ```bash
    fsd e user -r ./src/lib
    fsd entity user --root ./src/lib
    ```
    
    生产:
    
    -   `src/lib/entities/user/index.(js|ts)` (取决于您的项目)
-   用切片生成页面层 `edit-note` 财务报告和审定财务报表 `note-list`,每个部分 `ui` 财务报告和审定财务报表 `api`数字 :
    
    ```bash
    fsd p edit-note note-list -s ui, api
    fsd page edit-note, note-list -s ui api
    ```
    
    在检测到的 FSD root \[^1\] 或当前文件夹中,生成:
    
    -   `pages/edit-note/index.(js|ts)` (取决于您的项目)
    -   `pages/edit-note/ui/`
    -   `pages/edit-note/api/`
    -   `pages/note-list/index.(js|ts)`
    -   `pages/note-list/ui/`
    -   `pages/note-list/api/`
-   生成带有片段的共享层 `ui` 财务报告和审定财务报表 `api` 和每个部分的索引文件 :
    
    ```
    fsd s ui api
    fsd s -s ui api
    fsd shared ui -s api
    ```
    
    在检测到的 FSD root \[^1\] 或当前文件夹中,生成:
    
    -   `shared/ui/index.(js|ts)`
    -   `shared/api/index.(js|ts)`

## 贷项

感谢一个社区成员 [`Agent_RBY_`](https://github.com/AgentRBY) 用于执行大多数生成和检测逻辑.

## 许可证

该项目的源代码根据ISC许可证的规定来分配. 这就像麻省理工,但更好. [点击这里](https://choosealicense.com/licenses/isc/) 来学习这意味着什么.

\[^1\]:一个FSD根是Feature-Sliced Design中包含切片的文件夹. 在一个项目中可以有几个独立的根.

## 常见问题

### @feature-sliced/cli 是什么？

能够快速地从Feature-Sliced Design中生成地层,切片和片段\.

### 如何安装 @feature-sliced/cli？

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

### @feature-sliced/cli 支持 TypeScript 吗？

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

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

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

### @feature-sliced/cli 可以商用吗？

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

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

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

### @feature-sliced/cli 还在维护吗？

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