Skip to content
Boardroom

Install

Preview

View as Markdown

From source

Section titled “From source”

Requires Node 24.12.0 and npm. The native SQLite driver is installed by npm ci.

Terminal window
git clone https://github.com/francoisnoel62/Boardroom.git
cd Boardroom
npm ci
npm run build

Run any command with node dist/cli.js, for example node dist/cli.js --help.

A packaged candidate with Node included

Section titled “A packaged candidate with Node included”

  1. Build a candidate for the machine you are on. The command prints a new directory under release/.

    Terminal window
    npm run package

  2. Open a terminal in that directory and run the launcher. No installed Node is needed from here.

    Terminal window
    ./boardroom --help

The candidate contains its own Node runtime, the compiled application, its assets and prepared native dependencies. It targets the current platform and architecture only and publishes nothing. See the platform support matrix.

Update

Section titled “Update”

Build or download the newer candidate and replace the application directory. Your data lives elsewhere, in the data directory, and is reopened by the new version.

One-line installers

Section titled “One-line installers”

Once a release exists, scripts/install.sh (macOS on Apple silicon, Linux x64) and scripts/install.ps1 (Windows x64) download its package, refuse any SHA-256 mismatch against the release’s SHA256SUMS, and install it for your user without administrator rights:

Platform Application Command
macOS, Linux ~/.boardroom/versions/<version> ~/.local/bin/boardroom
Windows %LOCALAPPDATA%\Programs\Boardroom\versions\<version> boardroom.cmd, added to your user PATH

Set BOARDROOM_VERSION, BOARDROOM_INSTALL_DIR or BOARDROOM_BIN_DIR to change these defaults.

Remove

Section titled “Remove”

Delete the application directory — for an installer, the directories in the table above, and the PATH entry on Windows. To remove your data as well, delete the data directory for your platform; exports are wherever you chose to write them and are never deleted by BOARDROOM.