shipi | docs
GitHub

Quick Start

Prerequisites

  • Node.js 18+
  • A git repository with commits
  • A shipi API key (get one here)

1. Install

npm i -g @shipi/cli

2. Set your API key

export SHIPI_API_KEY=your-api-key

3. Generate release notes

Navigate to your git repository:

cd your-project

Generate notes for recent commits:

shipi generate

Or specify a commit range:

shipi generate v1.0.0..v1.1.0

Example output

## What's New

- Added user authentication with OAuth support
- Implemented dark mode toggle in settings
- Search results now load 2x faster

## Bug Fixes

- Fixed Safari login redirect issue
- Resolved memory leak in WebSocket handler

Next steps