OpenBoardCLI
Help users install, configure, and operate OpenBoardCLI from its published npm package.
Install and verify
Check prerequisites before suggesting commands:
- Node.js 18 or newer and npm.
- Python 3 with
beautifulsoup4for Gmail invoice fetchers. pdfplumberas well when bills arrive as PDF attachments.
Install globally and verify:
npm install -g openboard-cli
openboard --version
openboard --help
Launch the interactive terminal UI with openboard. For automation, use openboard agent ...; do not launch the TUI from a non-interactive agent.
Choose the operating mode
Explain the data boundary before setup:
- Local only: Ollama or LM Studio and a local preview; no dashboard data leaves the machine.
- Hybrid: Either a local LLM with GitHub/Vercel deployment, or a cloud LLM with local preview.
- All remote: A cloud LLM plus GitHub and Vercel deployment. This requires GitHub and Vercel tokens (or their supported authenticated CLI/Git integrations) and a runnable Codex CLI or another configured cloud provider such as OpenAI, Anthropic, Gemini, Moonshot, xAI, Mistral, or OpenRouter.
Never imply that GitHub or Vercel credentials are needed for local-only use. Users who want a fully local LLM may configure Ollama or LM Studio instead.
Common agent commands
Consult the live agent command contract when exact flags or current behavior matter.
openboard agent setup status --json
openboard agent create --data ./invoices.xlsx --name "Invoices" --type invoices
openboard agent update --dashboard invoices --prompt "add a month-over-month chart"
openboard agent billers sync --json
Prefer environment variables for credentials instead of putting secrets in command arguments. Do not expose tokens, API keys, Gmail App Passwords, or dashboard passwords in logs or examples.
Sources
- Website and quickstart: https://openboard-site.vercel.app/
- Repository: https://github.com/syedateebulislam/openboard
- Full agent reference: https://github.com/syedateebulislam/openboard/blob/main/Agent.md
