shipit-0.1.4 has been yanked.
███████╗██╗ ██╗██╗██████╗ ██╗████████╗
██╔════╝██║ ██║██║██╔══██╗██║╚══██╔══╝
███████╗███████║██║██████╔╝██║ ██║
╚════██║██╔══██║██║██╔═══╝ ██║ ██║
███████║██║ ██║██║██║ ██║ ██║
╚══════╝╚═╝ ╚═╝╚═╝╚═╝ ╚═╝ ╚═╝
Shipit is a Rust CLI that automates merge request creation on your favorite platforms with optional AI-generated notes | gitshipit.net
Installation
Install Script (macOS/Linux/Windows)
|
Cargo
Homebrew (macOS)
&&
From Source
Or grab a pre-built binary from the releases page.
Quick start
# 1. Generate a config file at the platform default location
# 2. Check the config out and edit settings with your editor
# 3. Ship it from the root of your project. See the command docs below for more options
Optional Requirements
- A GitLab account and api token with merge request permissions is required for merge request creation with the
--dry-runoption disabled - Ollama running locally with the model that matches your config is required for usage with the
--aioption enabled
Commands
b2b — Branch to Branch
shipit b2b <source> <target> [--ai] [--dryrun] [--dir <path>]
| Argument / Flag | Description |
|---|---|
source |
Branch with new commits (e.g. develop) |
target |
Destination branch (e.g. main) |
--ai |
Enable Ollama LLM to generate categorized release notes |
--dryrun |
Preview the merge request description without creating it |
--dir <path> |
Path to the git repository (defaults to current directory) |
What happens:
- Finds all commits on
sourcethat aren't ontarget - If
--aiis set, sends the commit log to a local LLM running with Ollama and generate categorized release notes (features, fixes, infra, docs) - Opens a merge request on GitLab or Github with the description
Examples:
# Basic — raw commit list as MR description
# With AI-generated release notes
# Dry run — see the description without creating the MR
# Point at a repo outside the current directory
config generate
Writes or overwrites a default config file to the platform config directory and prints the path.
Default config location:
- Linux:
~/.config/shipit/default-config.toml - macOS:
~/Library/Application Support/shipit/default-config.toml - Windows:
%APPDATA%\shipit\default-config.toml
config show
Prints the current config file path and its contents as TOML.
Platform support
| Platform | Architecture | Status |
|---|---|---|
| Linux | x86_64 | ✓ |
| macOS | x86_64 | ✓ |
| macOS | aarch64 | ✓ |
| Windows | x86_64 | ✓ |
Support
If shipit saves you time, a coffee goes a long way.
