shipi | docs

Introduction

Shipi is a CLI tool that generates release notes from your git commits using AI. It analyzes your commits and diffs to produce human-readable changelogs.

The problem

Writing release notes is tedious:

  • Digging through dozens of commits
  • Summarizing what actually changed
  • Formatting for different audiences
  • Doing this every single release

The solution

Shipi does it in one command:

shipi generate v1.0.0..v1.1.0

Output:

## What's New

- Added dark mode toggle in settings
- Search results now load 2x faster
- Fixed Safari login redirect bug

How it works

  1. Reads your commits — Shipi looks at commit messages and optionally the actual diffs
  2. Understands the changes — AI analyzes what was added, fixed, or changed
  3. Generates notes — Outputs formatted release notes for your chosen audience

Features

  • Multiple audiences — Generate notes for customers, developers, or internal teams
  • Ticket extraction — Automatically links JIRA and GitHub issues
  • CI/CD integration — Automate in GitHub Actions, GitLab CI, etc.
  • Multiple output formats — Markdown, JSON, or plain text