Installation

Before you continue

To install Rome, you must have node and npm installed on your system. If you do not have node and npm installed, install them before continuing.

Cloning and building

Rome is not available via npm and must be installed from GitHub. In a folder of your choice, clone the rome repository:

git clone https://github.com/romejs/rome

Then, navigate into it and build rome:

cd rome; ./scripts/build-release dist

On Windows 10 build rome using the following command using PowerShell 7:

cd rome && node scripts/build-release dist

Now, install rome globally:

npm install -g ./dist/

Congratulations! Rome is installed.

When it comes time to update Rome, repeat the above process. npm will automatically overwrite your existing Rome installation with the new version.