Master Guides
Installation
Get the CLI on your machine in one command.
Master is distributed as a global npm package. It requires Node.js 22.12 or newer.
Install the CLI globally#
terminal
$ npm install -g master
Verify it:
terminal
$ master --version # 2.2.0$ master info # banner + environment details
Requirements#
- Node.js ≥ 22.12 on a supported LTS line, on its latest patch — the framework and generated apps are pure ESM (MasterRecord’s SQLite driver needs Node 22+). Node 20 is end-of-life and no longer gets security fixes; the 2026-10-20 security releases are 22.23.4, 24.22.1 and 26.12.1.
- npm — bundled with Node; used for workspaces.
- A database — SQLite needs nothing; MySQL/PostgreSQL need a running server.
npm says better-sqlite3 has install scripts
npm 12 (and npm 11.19+) blocks dependency install scripts by default and lists them after
npm install. A Master app needs none: better-sqlite3 ships prebuilt binaries for macOS, Linux and Windows (x64 and arm64). Record that once with npm install-scripts deny better-sqlite3, or approve it on a platform without a prebuilt binary so it can compile. No global install?
You can always run the latest CLI without installing it:
npx master@latest new my-app.Updating#
terminal
$ npm update -g master