Skip to content
Boardroom

Quickstart

Available

View as Markdown

Explore the recorded example: a fictional SaaS launch in which a staffing objection narrows the plan, while one adviser keeps an open question on the record.

Prerequisites

Section titled “Prerequisites”
  • Node 24.12.0 and npm, for the development checkout.
  • A terminal on macOS (Apple silicon), Windows x64 or Linux x64.
  • No account, API key or model download.

Explore the recorded example

Section titled “Explore the recorded example”

  1. Get the source and install its pinned dependencies, including the native SQLite driver.

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

  2. Read the recorded discussion. Repeating the command resumes from the saved position; add --next to read one intervention at a time.

    Terminal window
    node dist/cli.js demo --data-dir .boardroom/example

  3. Inspect the saved source line behind the staffing objection.

    Terminal window
    node dist/cli.js evidence --line 4 --data-dir .boardroom/example

  4. Export a new plan and decision memo, then review what happened.

    Terminal window
    node dist/cli.js export --output .boardroom/exports --data-dir .boardroom/example
    node dist/cli.js history --data-dir .boardroom/example
    node dist/cli.js decision --data-dir .boardroom/example

Run a packaged candidate

Section titled “Run a packaged candidate”

npm run package builds a directory containing its own Node runtime for the current platform. Open a terminal in the directory it prints:

Terminal window
./boardroom demo
./boardroom evidence --line 4
./boardroom export --output ./exports
./boardroom doctor --json

The candidate needs no installed Node. It builds for the current host platform only and publishes nothing.