Quick Start
Get up and running with Shipmark in under 2 minutes.
Prerequisites
Before you begin, make sure you have:
- Node.js 18+ installed
- A Git repository with at least one commit
- A package.json file (for Node.js projects)
Step 1: Install Shipmark
Install Shipmark globally using npm:
terminal
$ npm install -g @grazulex/shipmark
Or use npx to run without installing:
terminal
$ npx @grazulex/shipmark release
Step 2: Initialize Configuration (Optional)
Create a .shipmarkrc.yml configuration file:
terminal
$ shipmark init
✔ Configuration file created: .shipmarkrc.yml
This step is optional—Shipmark works with sensible defaults.
Step 3: Check Release Status
Before releasing, check your current status:
terminal
$ shipmark status
📦 Release Status
──────────────────────────────────────
Branch: main
Package version: 0.0.0
Latest tag: none
📝 Pending Changes
──────────────────────────────────────
3 commits (no previous tag)
Features 2
Bug Fixes 1
Step 4: Create Your First Release
Now create your first release:
terminal
$ shipmark release
ℹ Current version: 0.0.0
ℹ 3 commits since last release
? Select version bump:
❯ minor → 0.1.0
patch → 0.0.1
major → 1.0.0
✔ Version files updated
✔ Changelog updated
✔ Release commit created
✔ Tag v0.1.0 created
✔ Pushed to remote
🚀 Released 0.1.0