Skip to content

CLI

Available

View as Markdown

This table is generated at build time from the help text in src/cli.ts, and a test checks that it lists exactly the commands the CLI accepts. Run boardroom --help (or node dist/cli.js --help) to see the same text.

CommandWhat it does
boardroom route-configure --input <json-file> [--catalog]Save an unverified declared or supported route
boardroom provider-preflight --project <id> --id <meeting-id> --adviser <id> --allow-provider [--session]Paid connection test
boardroom team-configure --input <json-file>Save the three-adviser Plan 02 profile
boardroom configuration [--json]Inspect shareable configuration without credentials
boardroom credential-set --route <id>Enter a masked credential into the host vault
boardroom credential-set --route <id> --secret-stdinStore an explicitly piped credential
boardroom credential-check --route <id> [--session]Check presence without showing the key
boardroom credential-delete --route <id>Delete this route's host credential
boardroom project-create --name <name> [--language en]Create a real project
boardroom project --id <project-id>Inspect a saved project
boardroom source --project <id> --source <file> --allow-sourceSave authorized UTF-8 text
boardroom meeting-prepare --project <id> --input <json-file> [--team <id>]Freeze a question and selected passages
boardroom meeting --project <id> --id <meeting-id>Inspect a prepared meeting
boardroom meeting-context --project <id> --id <meeting-id>Read its frozen text passages
boardroom meeting-start --project <id> --id <meeting-id> --allow-provider [--session]Produce PO framing and wait
boardroom meeting-framing --project <id> --id <meeting-id>Inspect durable framing versions
boardroom meeting-approve --project <id> --id <meeting-id> --version <n>Approve the displayed framing
boardroom meeting-correct --project <id> --id <meeting-id> --version <n> --input <json-file>Save a human correction
boardroom meeting-stop --project <id> --id <meeting-id>Stop and preserve saved framing
boardroom meeting-analyse --project <id> --id <meeting-id> --allow-provider [--session]Three independent analyses
boardroom meeting-analyses --project <id> --id <meeting-id>Inspect saved analyses and missing advisers
boardroom meeting-debate --project <id> --id <meeting-id> --allow-provider [--session]Confront and revise
boardroom meeting-proposals --project <id> --id <meeting-id>Inspect proposal versions and objections
boardroom meeting-views --project <id> --id <meeting-id> --version <n> --allow-provider [--session]Three final views
boardroom meeting-final-views --project <id> --id <meeting-id>Inspect current, missing and stale views
boardroom meeting-decide --project <id> --id <meeting-id> --input <json-file>Save a human decision
boardroom meeting-decision --project <id> --id <meeting-id>Inspect the live decision record
boardroom meeting-export --project <id> --id <meeting-id> --output <directory> [--with-json] [--session]New live exports
boardroom live --project <id> (--id <meeting-id> | --team <id> --input <question-json>) --output <directory> --allow-provider [--session]Interactive live terminal
boardroom execution-configure --project <id> --id <meeting-id> [--input <json-file>]Freeze protected reserves, computed for the team unless a file sets them
boardroom calls --project <id> --id <meeting-id>Inspect budgets, time and call receipts
boardroom execution-stop --project <id> --id <meeting-id>Stop pending and in-flight work
boardroom execution-conclude --project <id> --id <meeting-id>Protect early conclusion
boardroom demo [--next]Read or resume the recorded example
boardroom evidence [--line 4]Inspect the saved source revision
boardroom document --source <file> --allow-sourceSave authorized PDF/DOCX text
boardroom evidence --id <id> --page <n>Inspect a saved PDF page
boardroom evidence --id <id> --block <n>Inspect a saved DOCX block
boardroom export --output <directory>Create a new plan and decision memo
boardroom history [--project <id>] [--json]Inspect saved events and export receipts
boardroom decision [--json]Inspect saved context, proposals and adviser views
boardroom trace --output <directory> [--project <id>]Export a filtered local technical trace
boardroom statusShow local capabilities

In this build, the CLI accepts status but has no handler for it, so it prints the help text.

boardroom doctor [--json]Run separate local storage probes
boardroom terminal-checkTry input during a fictional stream (TTY only)
boardroom isolation-check --output <directory>Measure fixed temporary protection probes

Global options: --data-dir <directory>, --terminal (Ink rendering), --json, --help.

Export and report commands use --output <directory> and create new files. Configuration and meeting commands persist records under --data-dir. Use --json where the help lists structured output. Exit codes are listed in Exit codes.