installation.md

Installation

Prerequisites

• Node.js 20.19.0+
• RemNote desktop app with the RemNote Automation Bridge plugin installed

Install from npm

Version compatibility (0.x semver): before installing/upgrading, check the Bridge / Consumer Version Compatibility Guide and pick a remnote-cli version compatible with your installed bridge plugin version.

npm install -g remnote-cli

# Example pinned install when you need a specific compatible version
npm install -g remnote-cli@0.5.0

Verify Installation

remnote-cli --version

Build from Source

Prefer a checkout/tag that matches your installed bridge plugin minor version. See the Bridge / Consumer Version Compatibility Guide.

git clone https://github.com/robert7/remnote-cli.git
cd remnote-cli
npm install
npm run build
npm link  # makes 'remnote-cli' available globally