Getting Started

Prerequisites

• Node.js >=22
• A Git repository with at least one commit
• An npm or JSR account (depending on your publish target)

Quick Start

npm

Install

npm install -D revola

Run (without install)

npx revola

pnpm

Install

pnpm add -D revola

Run (without install)

pnpm dlx revola

yarn

Install

yarn add -D revola

Run (without install)

yarn dlx revola

bun

Install

bun add -D revola

Run (without install)

bunx revola

Setup

1. Initialize Revola

   Run the init command to generate a default config file. See the default configuration: Default Config

   revola init

   This will create a .revola.json in your project.

   • .revola.json revola config file
   • package.json
   • …

2. Configure your project

   Edit the generated config file to match your setup:

   {
     "preset": "node",
     "npm": {
       "publish": true,
       "tokenRef": "NPM_TOKEN",
       "access": "public",
       "provenance": false
     },
     "jsr": {
       "publish": false,
       "tokenRef": "JSR_TOKEN",
       "packageManager": "npx"
     },
     "changelog": {
       "enabled": true,
       "file": "CHANGELOG.md",
       "title": "{{REVOLA_VERSION}} ({{REVOLA_DATE}})"
     }
   }

3. Preview a release

   Before making changes, run a dry run to preview what will happen:

   revola --dry-run