# @forinda/kickjs-cli 中文文档

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

版本：8\.18\.0
npm 元数据更新时间：2026-11-12T10:52:20.997Z
中文译文更新时间：2026-11-15T07:53:48.833Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：2.4 MB，168 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0
- 运行依赖：11 个
- peer 依赖：typescript \>=5\.0\.0，@typescript/typescript6 \*
- 首次发布：2026-03-19T23:54:57.967Z
- 最新版本发布：2026-11-12T10:52:20.645Z
- 近 30 天下载量：6301（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：207（近 12 个月 207 个）

## 中文简介

KickJS的CLI——项目脚手架、DDD模块生成、dev/building/启动

## 安装

```sh
npm install @forinda/kickjs-cli
```

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

## README

# @forinda/kickjs-cli (英语)

KickJS的CLI——项目脚手架、REST和最小模块发电机、dev/building/启动命令.

## 安装

```bash
pnpm add -D @forinda/kickjs-cli

# or scaffold a fresh project
npx @forinda/kickjs-cli new my-api
```

## 图标

CLI是一个dev依赖,所以在外壳中运行它通过您的软件包管理器—— `npx kick dev`, (中文(简体) ), `pnpm exec kick dev`, (中文(简体) ), `yarn kick dev`, (中文(简体) ), `bunx kick dev` ——或通过项目的脚本(`npm run dev`) (中文(简体) ). 一个赤裸的 `kick` 需要全局安装.

```bash
kick new <name>           # Scaffold a new KickJS project
kick dev                  # Start dev server with Vite HMR
kick build                # Production build via Vite
kick start                # Run production build

kick g module <name>      # Controller, service, repository, DTOs, tests
kick g scaffold <name> <fields…>  # CRUD module from field definitions
kick g controller|service|middleware|guard|adapter|plugin|contributor|dto|test <name>
kick g agents             # Regenerate AGENTS.md / CLAUDE.md / skills after an upgrade

kick rm module <name>     # Remove a module
kick add <pkg>            # Install a KickJS package + peers
kick add upload           # Install the multipart driver for your runtime
kick add --list           # Show all available packages

kick doctor               # Pre-flight checks (engine peers, upload driver, env wiring)
kick mcp start            # Run app as an MCP stdio server
kick typegen              # Refresh KickRoutes / KickEnv / KickRuntimeRegister type maps
```

`kick new` 交互( 模板、 运行时间、 软件包管理器、 寄存器、 软件包多选择、 git init、 安装) —— 每个提示都有 CI 的旗: `--template rest|minimal|fullstack`, (中文(简体) ), `--runtime express|fastify|h3`, (中文(简体) ), `--pm pnpm|npm|yarn|bun`, (中文(简体) ), `--repo inmemory|<db-name>` (例如:. `postgres`, (中文(简体) ), `--packages swagger,ws,queue,devtools`, (中文(简体) ), `--no-git`, (中文(简体) ), `--no-install`, (中文(简体) ), `--force`, (中文(简体) ), `-y/--yes`。 。 。 .

## HTTP 运行时间

KickJS 运行 **快递** (违约), **快捷化**,或 **h3 (韩语)** - 在脚手架时选择引擎 `kick new --runtime`,则 CLI 安装正确的引擎对等器并写入 `runtime` 输入 `kick.config.ts`。然后,该字段将驱动 Dep-aware 命令:

```bash
kick new my-api --runtime fastify   # scaffolds fastify + @fastify/middie, runtime: 'fastify'
kick add upload                     # → @fastify/multipart (express → multer, h3 → built-in)
kick doctor                         # verifies the engine peers + upload driver are present
kick typegen                        # emits KickRuntimeRegister so ctx.app / getRuntimeApp() are typed to the engine
```

## 文档

[kickjs.app/guide/cli-命令](https://kickjs.app/guide/cli-commands) ——每个命令+旗帜,自定义命令通过 `kick.config.ts`发电机结构.

## 许可证

麻省理工学院

## 常见问题

### @forinda/kickjs-cli 是什么？

KickJS的CLI——项目脚手架、DDD模块生成、dev/building/启动

### 如何安装 @forinda/kickjs-cli？

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

### @forinda/kickjs-cli 支持 TypeScript 吗？

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

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

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

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

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

### @forinda/kickjs-cli 可以商用吗？

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

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

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

### @forinda/kickjs-cli 还在维护吗？

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