# @backstep/cli 中文文档

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

版本：1\.0\.14
npm 元数据更新时间：2026-11-07T04:04:43.635Z
中文译文更新时间：2026-11-07T22:27:46.910Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：17.4 kB，4 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=22
- 运行依赖：0 个
- 首次发布：2026-10-30T19:03:32.340Z
- 最新版本发布：2026-11-07T04:04:43.446Z
- 近 30 天下载量：2271（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：16（近 12 个月 16 个）

## 中文简介

bs,后台CLI. 每个指令都运行在现场项目上.

## 安装

```sh
npm install @backstep/cli
```

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

## README

# @ backstep/ cli (英语)

`bs`时,命令行 [后退步骤](https://backstep.dev/)每一个命令都运行在你的现场项目上.

```sh
npx @backstep/cli pull c0ffee   # set up ./c0ffee; asks for the project's secret once
cd c0ffee
npx bs stub Reef.Snorkeler.fullName
npx bs run Reef.Snorkeler.fullName
```

运行 `bs help` 每个命令。 它需要节点22 或以后.

`bs` 是您工程服务器的 MCP 客户端 `https://backstep.dev/<id>/bs/mcp`: 除此之外 `pull` 财务报告和审定财务报表 `stub`,它的命令是服务器的工具,例如. `bs relink` 页:1 `Index__Index__relink`。任何MCP客户端都可以连接到同一个URL,以秘密为无记名符号或通过OAuth.

没有文件夹吗? 将项目和秘密命名, 从任何地方命名 : `BACKSTEP_PROJECT=<id> BACKSTEP_SECRET=<secret> npx @backstep/cli refs`,或 `--project` 财务报告和审定财务报表 `--secret`。除此之外,一切都以这种方式运作 `bs stub`,它会写一个文件.

```
<projectId>/
  project.json        the project's id, and its server if not backstep.dev
  .secret             its secret; keep it out of git (bs pull writes a .gitignore)
  project/            a folder per package, starting with the project's own
    .backstep/        snapshots of the live index and types: don't edit
    snorkeler/fullName.ts   your code, one file per code slot
```

-   **软件包 :** `bs change Billing create` 添加a `billing/` 文件夹.
-   **抓图 :** 从不编辑 `.backstep` 文件夹; 用 `bs change`。 。 。 .
-   **服务器** 实值 `https://backstep.dev`。 。 。 . `--url` 或者说 `BACKSTEP_URL` 其他点,以及 `BACKSTEP_SECRET` 可以握住这个秘密,而不是 `.secret`。 。 。 .

## 常见问题

### @backstep/cli 是什么？

bs,后台CLI\. 每个指令都运行在现场项目上\.

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

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

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

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

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

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

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

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

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

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

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

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

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

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