# @basenative/cli 中文文档

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

版本：3\.0\.0
npm 元数据更新时间：2026-10-31T13:46:56.235Z
中文译文更新时间：2026-10-31T16:53:14.485Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40basenative/cli
原文对照：https://npmcn.com/package/%40basenative/cli/?lang=original
项目主页：https://github.com/DuganLabs/BaseNative/tree/main/packages/cli#readme
源码仓库：https://github.com/DuganLabs/BaseNative

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

- 包体积（解压后）：149 kB，69 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-03-20T05:27:46.829Z
- 最新版本发布：2026-10-31T13:46:55.839Z
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

bn CLI：创建、部署、医生和from-jsx （React草稿到BaseNative模板）

## 安装

```sh
npm install @basenative/cli
```

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

## README

# @basenative / cli

> 这个 `bn` 命令-每个BaseNative / DuganLabs项目的前门。

脚手架，prd，规范驱动的工作流(兼容 [github / spec-kit](https://github.com/github/spec-kit)), GitHub 里程碑/问题，Nx，牧马人+多普勒部署，和a `doctor` 调用 漂移。零重依赖-仅限节点内置。

## 安装

```bash
npm install -g @basenative/cli
# or, without installing:
npx @basenative/cli create my-app
```

## 快速启动

```bash
bn create my-app --template t4bs
cd my-app
bn dev
bn deploy --preview
```

## 命令

### 前门

| 命令 | 它是做什么的 |
| --- | --- |
| `bn create <name> [-t <template>]` | 完成一个新项目。模板: `webapp` (默认), `worker`， `library`， `t4bs`． 遗产: `minimal`， `enterprise`， `api`. |
| `bn prd init` | 写 `docs/PRD.md` 从t4bs格式支架。 |
| `bn prd edit` | 开放 `docs/PRD.md` 在 `$EDITOR`. |
| `bn prd sync` | 解析里程碑部分→ `.bn/prd-issues.json` (被 `bn gh sync`）。 |
| `bn speckit init` | 引导 `.specify/` （内存、规格、模板）。 |
| `bn speckit spec <name>` | 脚手架 `.specify/specs/NNN-name/spec.md`. |
| `bn speckit plan` | 存根 `plan.md` 对于活动规范。 |
| `bn speckit tasks` | 提取 `tasks.md` 项→ `.bn/speckit-tasks.json`. |
| `bn speckit validate` | 为必需的字段检查规范/计划/任务。 |
| `bn gh sync` | 幂等地创建里程碑+问题 `.bn/*.json`. |
| `bn gh board` | 创建/验证此版本的org项目。 |
| `bn gh automate` | 验证 `.github/workflows/deploy.yml` 参考文献 `DuganLabs/.github` 可重用工作流。 |
| `bn nx [...]` | 透传, `nx` （使用您检测到的pm）。 `--task <t> [--affected]` 普通运行的简写。 |

### 工作流

| 命令 | 它是做什么的 |
| --- | --- |
| `bn dev` | 先用热模块替换（npm-script）运行项目的开发服务器 `node --watch`,然后 `wrangler dev`）。 `--no-hmr` 选择了。 |
| `bn deploy --prod` / `--preview` | `wrangler pages deploy` (或 `wrangler deploy`)，用… `doppler run --` 如果安装了多普勒。 |
| ' bn部署——env <预览 | 暂存 |
| `bn doctor` | 验证节点版本， `.nvmrc`、packageManager、eslint config、tsconfig、多普勒required。json, deploy.yml。 |
| `bn build` | 为生产构建。 |
| `bn generate <type> <name>` | 生成一个 `component`， `route`，或者 `page`. |
| ' bn env <list | 集 |
| `bn analyze [dir]` | 包大小+依赖报告。 |

## 选项

每个命令都支持 `--help`/`-h`． 顶级国旗:

-   `-h, --help` 显示帮助。
-   `-v, --version` 打印安装的CLI版本。

发出数据的命令接受 `--json`． 改变文件系统的命令 或者远程状态接受 `--dry-run`.

## 的端到端示例

```bash
# 1. Scaffold and check
bn create rocket --template webapp
cd rocket
bn doctor

# 2. Author a PRD, sync to GitHub
bn prd init --owner "Warren"
$EDITOR docs/PRD.md         # fill in milestones
bn prd sync
bn gh sync                  # idempotent

# 3. Spec a feature
bn speckit init
bn speckit spec onboarding
bn speckit plan
bn speckit tasks
bn gh sync --input .bn/speckit-tasks.json

# 4. Build and ship
bn dev
bn deploy --preview
bn deploy --prod
```

## 模板

所有模板随附：

-   `package.json` 引用 `@basenative/*` 包。
-   `eslint.config.js` 扩展 `@basenative/eslint-config`.
-   `tsconfig.json` 扩展 `@basenative/tsconfig`.
-   `.nvmrc`， `.prettierrc`， `.gitignore`.
-   `wrangler.toml` (如适用)。
-   `.github/workflows/deploy.yml` 调用可重用工作流 `DuganLabs/.github`.

| 模板 | 堆栈 |
| --- | --- |
| `webapp` | Cloudflare Pages SPA + Worker, BaseNative runtime/router/server。 |
| `worker` | Cloudflare Worker （API / cron / queue）。 |
| `library` | npm-可发布库，Apache-2.0。 |
| `t4bs` | 游戏支架的使用 `@basenative/og-image`， `keyboard`， `share`， `auth-webauthn`， `admin`， `persist`. |

## 清单

`manifest.json` 枚举每个命令、子命令和标志-用于 壳牌完井和下游工具。

## 许可证

apache - 2.0。

## 常见问题

### @basenative/cli 是什么？

bn CLI：创建、部署、医生和from-jsx （React草稿到BaseNative模板）

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

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

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

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

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

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

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

@basenative/cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

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

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