Commands

Complete reference for all Shipmark CLI commands and options.

shipmark release

Create a new release with changelog, tag, and push to remote. This is the main command for releasing new versions.

Examples
$ shipmark release # Interactive mode
$ shipmark release --dry-run # Preview without executing
$ shipmark release --ci auto # CI mode with auto detection
$ shipmark release --ci minor # CI mode with minor bump
$ shipmark release -p beta # Create beta prerelease
$ shipmark release --skip-push # Don't push to remote

Options

-d, --dry-run Preview changes without executing
--skip-changelog Skip changelog generation
--skip-tag Skip tag creation
--skip-push Skip pushing to remote
-p, --prerelease <type> Create prerelease (alpha, beta, rc)
-y, --yes Skip confirmation prompts
--ci <bump> CI mode: auto, patch, minor, major, prerelease
shipmark status

Check the current release status before creating a release. Shows pending changes, suggested version bump, and more.

Example Output
$ shipmark status
📦 Release Status
──────────────────────────────────────
Branch: main
Package version: 1.2.3
Latest tag: v1.2.3
Working tree: clean
📝 Pending Changes
──────────────────────────────────────
5 commits since v1.2.3
Features 2
Bug Fixes 2
Documentation 1
🚀 Suggested Release
──────────────────────────────────────
Current: 1.2.3
Next: 1.3.0 (minor)

Options

-v, --verbose Include commit details
shipmark history

View release history with dates and commit counts.

Example Output
$ shipmark history
Release History
──────────────────────────────────────
┌─────────┬────────────┬─────────┐
│ Version │ Date │ Commits │
├─────────┼────────────┼─────────┤
│ 1.3.0 │ 2024-01-15 │ 5 │
│ 1.2.0 │ 2024-01-10 │ 8 │
│ 1.1.0 │ 2024-01-05 │ 3 │
└─────────┴────────────┴─────────┘

Options

-d, --details Show commit details for each release
-l, --limit <number> Limit number of releases to show (default: 10)
shipmark changelog

Generate or preview changelog from commits.

Examples
$ shipmark changelog # Update CHANGELOG.md
$ shipmark changelog --preview # Preview without writing
$ shipmark changelog --from v1.0.0 # From specific tag

Options

--preview Preview changelog without writing to file
--from <tag> Generate changelog from specific tag
shipmark version

Manage project version.

Examples
$ shipmark version # Show current version
$ shipmark version bump # Interactive bump
$ shipmark version bump minor # Specific bump type
$ shipmark version set 2.0.0 # Set exact version
shipmark tag

Manage Git tags.

Examples
$ shipmark tag list # List all tags
$ shipmark tag latest # Show latest tag
$ shipmark tag create 1.2.0 # Create new tag
$ shipmark tag delete v1.2.0 -r # Delete from local and remote

Options (delete)

-r, --remote Also delete from remote
shipmark init

Initialize Shipmark configuration in your project.

Examples
$ shipmark init # Interactive setup
$ shipmark init -y # Use defaults

Options

-y, --yes Use default configuration