Skip to content

Quick Start

pubm orchestrates releases for projects that publish to multiple registries, packages, or ecosystems.

pubm is built for repositories that already use Git and have a valid package manifest.

  • Git 2.11+
  • A package manifest such as package.json
  • A clean working tree before you publish

pubm ships as a Bun-built single binary. You do not need a separate Node.js runtime to run the CLI, although npm-based installation still uses your package manager toolchain.

Install the CLI globally:

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

If you are wiring pubm through Claude Code, Codex, or another coding agent, start with the setup automation instead of writing release prompts by hand.

  • Run pubm setup-skills to download and install coding agent skills directly, or let pubm init offer skill installation as its last step.
  • Use the publish-setup skill from the pubm plugin bundle if you want the release workflow, config, CI wiring, and changesets in one pass.
  • Give your agent the INSTALLATION.md link so it can fetch the bundle and begin with publish-setup.
  • Read Coding Agent Integration for the integration model and skill roles.

Run the interactive setup wizard:

Terminal window
pubm init

The wizard detects your packages and registries, then walks you through branch settings, versioning strategy, changelog, changesets, CI workflow generation, and coding agent skills. It only writes a config file when your choices differ from the defaults.

Start the release flow:

Terminal window
pubm

If pending changesets exist, pubm consumes them during the version step of the release pipeline. For packages without changesets, pubm can also analyze conventional commits (feat:, fix:, etc.) as a fallback — see Changesets for details. For config details, read Configuration. For CI, tokens, and preparation behavior, read CI/CD. For monorepos, read Monorepo. For exact flags and subcommands, read the CLI Reference.