Getting Started

Install

npm install tegami -D

Add -w if you install from a monorepo workspace root.

Tegami requires Node.js 24 or later.

Configure

Create an entry script in your repo root.

import { tegami } from "tegami";
import { runCli } from "tegami/cli";
import { github } from "tegami/plugins/github";

const paper = tegami({
  plugins: [
    github({
      repo: "your-org/your-repo",
      versionPr: {
        base: "main",
      },
    }),
  ],
  packages: {
    // optional: package options
    "your-package": {},
  },
});

await runCli(paper);

Add a package script so the CLI is easy to run:

{
  "scripts": {
    "tegami": "node scripts/tegami.mts"
  }
}

Tegami discovers npm workspace packages automatically, see Plugins for other languages. Use the packages option to override release settings per package.

CLI commands

runCli wraps the programmatic API. Pass the same tegami() instance you use in scripts.

And more from plugins.

Locally, tegami and tegami version use interactive prompts. In CI (CI=true), prompts are skipped and commands run non-interactively.

Typical local workflow

1. Run pnpm tegami to create a changelog file (or write one manually under .tegami/).
2. Commit the changelog and push.
3. CI runs tegami ci to version packages and open a Version Packages pull request.
4. Merge the version PR; the next CI run publishes packages.

See CI Setup for a GitHub Actions workflow.