TegamiGetting Started
Install Tegami and configure your first release workflow.
Install
npm install tegami -DAdd -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 { createCli } 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": {},
},
});
void createCli(paper).parseAsync();Add a package script so the CLI is easy to run:
{
"scripts": {
"tegami": "node scripts/tegami.mts"
}
}Tegami discovers npm and Cargo workspace packages automatically. Use the packages option to override release settings per package.
CLI commands
createCli wraps the programmatic API. Pass the same tegami() instance you use in scripts.
| Command | Description |
|---|---|
tegami | Create changelog files interactively or from conventional commits |
tegami version | Draft version changes and write the publish lock |
tegami publish | Publish packages from the publish lock |
tegami ci | Version if changelogs are pending, otherwise publish |
tegami pr preview | Build a pull request release preview (for CI) |
tegami pr comment | Post a release preview artifact as a pull request comment (requires a workflow_run event) |
tegami cleanup | Optionally remove a finished publish lock file from .tegami/ |
tegami init-agent | Append AGENTS.md instructions for AI agents writing changelogs |
Locally, tegami and tegami version use interactive prompts. In CI (CI=true), prompts are skipped and commands run non-interactively.
Typical local workflow
- Run
pnpm tegamito create a changelog file (or write one manually under.tegami/). - Commit the changelog and push.
- CI runs
tegami cito version packages and open a Version Packages pull request. - Merge the version PR; the next CI run publishes packages.
See CI Setup for a GitHub Actions workflow.