# @burdenoff/workspaces-cli 中文文档

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

版本：2026\.1031\.2
npm 元数据更新时间：2026-10-31T16:07:59.533Z
中文译文更新时间：2026-10-31T17:36:32.305Z
软件包许可：UNLICENSED

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

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

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

- 包体积（解压后）：16.3 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.11\.0
- 运行依赖：4 个
- 首次发布：2026-10-31T15:43:33.818Z
- 最新版本发布：2026-10-31T16:07:59.354Z
- 已发布版本数：4（近 12 个月 3 个）

## 中文简介

用于Burdenoff工作区平台操作和管理的命令行接口

## 安装

```sh
npm install @burdenoff/workspaces-cli
```

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

## README

# 工作区CLI

用于Burdenoff工作区平台的命令行界面。

这是一层薄薄的产品壳 [`@burdenoff/cli-sdk`](https://github.com/algoshred/cli-sdk)． 所有的命令逻辑都在SDK中；这个repo只提供特定于产品的默认值，并选择要挂载的SDK模块。

## 安装

```bash
npm install -g @burdenoff/workspaces-cli   # or: bun add -g @burdenoff/workspaces-cli
workspaces --version
```

不安装运行：

```bash
npx @burdenoff/workspaces-cli --help
```

这个包安装了两个等价的命令， `workspaces` 和 `workspaces-cli`.

## 释放

发布版本为CalVer (`YYYY.MDD.PATCH`)，并通过 `.github/workflows/release.yml`， 共享的algoshred/dev发布工作流。将CalVer标签推送到正在进行的提交上 `main`，或者从Actions选项卡调度工作流，并使用一个空版本 今天的下一个免费补丁。版本在发布时盖章，从未提交 回来,所以 `package.json` 保留一个占位符。看到 `dev/platform/context/delivery/cicd/HOW_TO_RELEASE_CLIENT_PACKAGES.md`.

## 开发

```bash
bun run dev              # run from source
bun run test             # unit tests (mock-based, no network calls)
bun run test:coverage    # coverage report
bun run sanity           # format + lint + type-check + test + build
```

## 使用

```bash
# Log in via OAuth2 device code flow (opens a browser approval page)
workspaces auth login

# Or authenticate as an app with client credentials
workspaces auth login --client-credentials --workspace-id <workspace-id>

# Select the active workspace
workspaces workspace set <workspace-id>

# List available workspaces
workspaces workspace list

# See all commands
workspaces --help
```

## 配置

配置存储在 `~/.config/workspaces-cli/`.

CLI默认为生产端点：

-   工作区GraphQL: `https://graphqlworkspaces.burdenoff.com/workspaces/graphql`
-   全球GraphQL: `https://graphql.burdenoff.com/global/graphql`

仅通过环境变量覆盖：

```bash
WORKSPACES_WORKSPACE_ENDPOINT=http://localhost:4003/workspaces/graphql \
WORKSPACES_GLOBAL_ENDPOINT=http://localhost:4000/global/graphql \
  workspaces workspace list
```

## 许可证

专有- Burdenoff咨询服务有限公司

## 常见问题

### @burdenoff/workspaces-cli 是什么？

用于Burdenoff工作区平台操作和管理的命令行接口

### 如何安装 @burdenoff/workspaces-cli？

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

### @burdenoff/workspaces-cli 支持 TypeScript 吗？

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

### @burdenoff/workspaces-cli 支持 ESM 还是 CommonJS？

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

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

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

### @burdenoff/workspaces-cli 可以商用吗？

@burdenoff/workspaces-cli 使用 UNLICENSED 许可。作者声明为 UNLICENSED，即不授予公开使用许可（与公共领域的 Unlicense 不同）。使用前需获得作者授权。以上为概括，不构成法律意见，请以许可原文为准。

### @burdenoff/workspaces-cli 还在维护吗？

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