跳转到内容

快速开始

pubm 是面向会发布到多个 registry、多个包或多个生态的项目的发布编排工具。

pubm 适用于已经使用 Git 且拥有有效 package manifest 的仓库。

  • Git 2.11+
  • 一个 package manifest,例如 package.json
  • 发布前保持干净的工作区

pubm 本身以 Bun 构建的单文件二进制分发。仅为了运行 CLI 并不需要单独的 Node.js runtime,不过通过 npm 安装时仍会使用你的包管理器工具链。

全局安装 CLI:

Terminal window
# npm
npm i -g pubm
# Homebrew
brew tap syi0808/pubm
brew install pubm

如果你要通过 Claude Code、Codex 或其他 coding agent 接入 pubm,请先从 setup automation 开始,而不是手写发布提示词。

  • 运行 pubm setup-skills 直接下载并安装 coding agent skills,或者让 pubm init 在最后一步提供 skill 安装选项。
  • 或者,使用 pubm plugin bundle 中的 publish-setup skill 来安装发布工作流、生成配置、接入 CI 并启用 changesets。
  • INSTALLATION.md 链接交给你的 agent,这样它就能获取 bundle 并从 publish-setup 开始。
  • 阅读 Coding Agent Integration 了解集成模型和各 skill 的职责。

运行交互式 setup 向导:

Terminal window
pubm init

向导会检测你的包和 registry,然后引导你完成分支配置、版本策略、changelog、changesets、CI 工作流生成和 coding agent skills。只有当你的选择与默认值不同时,才会创建配置文件。

启动发布流程:

Terminal window
pubm

如果存在待处理的 changeset,pubm 会在发布流程的版本步骤中消耗它们。对于没有 changeset 的包,pubm 也可以将 conventional commits(feat:fix: 等)作为降级回退来分析——详见 Changesets。配置细节请阅读 Configuration。CI、token 和 CI preparation 行为请阅读 CI/CD。monorepo 请阅读 Monorepo。精确的 flags 和子命令请阅读 CLI Reference