Goban Source
GitHub
Back to Open Source Projects

PushToDisplay CLI

Command-line interface and MCP server for Push To Display — send real-time updates to display boards from your terminal or AI agents.

npm Versionnpm Downloads

PushToDisplay CLI

The pushtodisplay command-line interface and built-in MCP server for Push To Display. Send real-time updates to display boards from your terminal, CI/CD pipelines, or AI agents.

Install

Run directly with npx — no install needed:

npx pushtodisplay --help

Or install globally:

npm install -g pushtodisplay

Requires Node.js 18+.

Quick Start

# Log in (opens browser)
pushtodisplay auth login

# Send an update (uses your default board)
pushtodisplay send "Hello, Display!"

# Send to a specific board
pushtodisplay send -b <board-id> "Deploy completed"

# List your boards
pushtodisplay boards list

MCP Server

The CLI includes a built-in Model Context Protocol server, giving AI agents (Claude, Cursor, VS Code Copilot, and others) direct access to your display boards. It inherits your CLI session — if you have run pushtodisplay auth login, it authenticates automatically.

claude mcp add pushtodisplay -- npx pushtodisplay mcp

Available MCP tools: pushtodisplay_send_update, pushtodisplay_list_boards, pushtodisplay_get_board, pushtodisplay_create_board, pushtodisplay_update_board, pushtodisplay_set_default_board, pushtodisplay_delete_board, pushtodisplay_list_devices.

License

MIT.

Technologies Used

TypeScriptNode.jsMCP