📦 Releasy CLI

Releasy is a lightweight, interactive CLI tool for versioning, tagging, changelog generation, and GitHub release automation in TypeScript/Node.js projects.

✨ Features

• 🔖 Semantic versioning with optional build metadata
• 🧠 Git safety checks: uncommitted or unpushed changes
• 📝 Markdown changelog input via terminal
• 🏷️ Git tagging and pushing
• 🚀 GitHub release creation via gh CLI
• 🧩 .releasyrc.json for default config
• 🧪 --dry-run support
• ✅ --yes for auto-confirm
• 🛠️ --config, --changelog overrides
• 📖 --help built-in documentation

📦 Installation

npm install -g ./releasy-js  # or npm link after building

🚀 Usage

releasy [options]

Options

| Flag | Description | |-------------------|--------------------------------------------------| | --help | Show CLI help message | | --dry-run | Simulate the release process (no writes) | | --yes | Skip all confirmation prompts | | --config <file> | Use custom config instead of .releasyrc.json | | --changelog <file> | Save changelog to a specific file |

Example

releasy --changelog tool/changelog_v2.1.0.md --yes

🔧 .releasyrc.json (optional)

{
  "repo": "kennedyowusu/releasy-js",
  "defaultTitle": "My Release",
  "skipConfirm": true,
  "useBuildNumber": true,
  "autoPush": true,
  "changelogFilePath": "tool/changelog_latest.md"
}

🛠 Development

Build and link locally

npm install
npm run build
npm link

Run manually

node dist/bin/index.js

🧾 License

MIT — feel free to use, improve, and share.

Built with ❤️ by Kennedy Owusu