Tarsi

Warning

We are in the early stages of development and this is a work in progress. Please be aware of possible bugs, incomplete or not yet implemented features. We welcome feedback and contributions.

Tarsi is an AI-powered CLI that automatically generates clear, user-focused changelogs from recent git changes, minimizing manual effort and keeping users informed.

Installing

To install the CLI, use NPM:

npm install -g tarsi

Or with other package managers like PNPM, Yarn, or Bun!

Adding the Script to your package.json (Recommended)

Add the changelog script to your package.json:

// package.json
{
  // ...
  "scripts": {
    "changelog": "tarsi"
  }
  // ...
}

Usage

To generate a changelog from the git diff since the latest tag, run:

tarsi generate

To check the changelog against the git diff, run:

tarsi check

Configuration

You can customize Tarsi's behavior by creating a tarsi.config.ts file in your project root. This file should export a CONFIG object with your custom settings.

Example Configuration

// tarsi.config.ts
export const CONFIG = {
  model: "gemini-2.5-flash",
  reviewPath: "custom-review.md",
  changelogPath: "CHANGELOG.md",
  changelogSliceEnd: 2,
  changelogStyleguide: `
    # Custom Style Guide
    - Use present tense for new features
    - Group changes by type
    - Include relevant PR numbers
  `,
  gitDiffPatterns: [
    "!dist/*",
    "!build/*",
    "!node_modules/*",
  ],
}

Configuration Options

• model: AI model to use for content generation (default: "gemini-2.5-flash")
• reviewPath: File path where generated reviews will be saved
• changelogPath: File path to the changelog file
• changelogSliceEnd: Number of entries to slice from the end of the changelog
• changelogStyleguide: Style guide text for changelog formatting
• gitDiffPatterns: Array of git diff patterns to exclude from analysis

If no configuration file is found, Tarsi will use sensible defaults.

---

Contribute • Security • License