Getting Started //Installation & CLI Setup
Docs/Getting Started/Installation & CLI Setup

Installation & CLI Setup

Comprehensive setup instructions for npm, pnpm, yarn, and air-gapped offline environments.
3 min read
Last updated: 2026-08-17

Package Manager Commands

OpenBoard is distributed via npm and works with all major Node.js package managers:

bash
# Using npm
npm install -g openboard-app

# Using pnpm
pnpm add -g openboard-app

# Using yarn
yarn global add openboard-app

System Requirements

  • Node.js: v18.0.0 or higher (v20+ recommended)
  • Operating Systems: macOS (Apple Silicon & Intel), Linux (Ubuntu, Debian, Fedora, Arch), Windows (WSL2 or native Node)
  • Memory Footprint: < 60 MB RAM for the core daemon and SQLite engine.

Air-Gapped Offline Setup

For isolated enterprise environments with strict outbound firewall policies, OpenBoard can be downloaded as a tarball and run completely offline without ever reaching out to external networks:

bash
# Launch with explicit localhost binding and offline flag
openboard start --host 127.0.0.1 --offline
Was this page helpful?
Edit this page on GitHub

© 2026 OpenBoard. 100% Free & MIT Licensed.

Database: ~/.openboard/openboard.db