@burdenoff/workspaces-cli

中文文档

2026.1031.2发布于 2026/11/01UNLICENSEDTypeScriptES Module

Command-line interface for Burdenoff Workspaces platform operations and management

文档目录6 节

Installation
Releasing
Development
Usage
Configuration
License

Workspaces CLI

Command-line interface for the Burdenoff Workspaces platform.

This is a thin product shell over @burdenoff/cli-sdk. All command logic lives in the SDK; this repo only provides product-specific defaults and selects which SDK modules to mount.

Installation

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

Run without installing:

npx @burdenoff/workspaces-cli --help

The package installs two equivalent commands, workspaces and workspaces-cli.

Releasing

Releases are CalVer (YYYY.MDD.PATCH) and go through .github/workflows/release.yml, the shared algoshred/dev release workflow. Push a CalVer tag on a commit that is on main, or dispatch the workflow from the Actions tab with an empty version to take today's next free patch. The version is stamped at publish time and never committed back, so package.json keeps a placeholder. See dev/platform/context/delivery/cicd/HOW_TO_RELEASE_CLIENT_PACKAGES.md.

Development

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

Usage

# 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

Configuration

Configuration is stored in ~/.config/workspaces-cli/.

The CLI defaults to production endpoints:

Workspaces GraphQL: https://graphqlworkspaces.burdenoff.com/workspaces/graphql
Global GraphQL: https://graphql.burdenoff.com/global/graphql

Override via environment variables only:

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

License

Proprietary — Burdenoff Consultancy Services Pvt. Ltd.

版本与发布记录

@burdenoff/workspaces-cli 共发布 4 个版本，首次发布于 2026/10/31；过去 12 个月发布了 3 个版本。

版本	发布日期	距今
`2026.1031.2`latest	2026/11/01	2 天前
`2026.1031.1`	2026/10/31	2 天前
`0.0.0-stage`	2026/10/31	2 天前
`2025.10.0`	2025/10/31	1 年前

关于 @burdenoff/workspaces-cli 的常见问题

@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 和提交记录判断。