Cli

📡 pushtodisplay

面向 Push To Display 的命令行界面和 MCP 服務器 —— 從終端或 AI 代理向顯示板發送即時更新。

📦 安裝

使用 npx 直接運行（無需安裝）：

npx pushtodisplay --help

或全局安裝：

npm install -g pushtodisplay

需要 Node.js 18+。查看 PushToDisplay 文檔 獲取指南、用例和 API 詳情。

🚀 快速開始

# 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

🔐 認證

使用你的 Push To Display 賬號登錄——與移動應用中使用的賬號相同。

瀏覽器登錄（默認）

pushtodisplay auth login

打開瀏覽器。登錄後，CLI 會自動接收你的憑據。

設備代碼登錄（無頭環境）

適用於沒有瀏覽器的機器——SSH 會話、容器或遠程服務器：

pushtodisplay auth login --device-code

CLI 會打印一個 URL 和一次性代碼。在任意設備上打開該 URL，輸入代碼並批准登錄。

憑據存儲在你的操作系統鑰匙串中（macOS Keychain、Linux libsecret、Windows Credential Manager）。如果鑰匙串不可用，則回退到 ~/.config/pushtodisplay/。

# Check auth status
pushtodisplay auth status

# Log out (clear stored credentials)
pushtodisplay auth logout

🧰 命令

send

向顯示板發送顯示更新。

# Simple text
pushtodisplay send -b my-board-id "Deploy succeeded"

# Styled text
pushtodisplay send -b my-board-id "Status" --size large --weight bold --color "#00FF00"

# Multiple blocks
pushtodisplay send -b my-board-id "Build:" "passing" --color "#22C55E"

# Panel targeting with layout options
pushtodisplay send -b my-board-id --panel 2 "Right panel content"
pushtodisplay send -b my-board-id --panel 1 --full-panel --density compact --align-x center "Alert"

# Per-block styling with JSON (repeatable)
pushtodisplay send -b my-board-id \
  --block '{"text": "API Health", "size": "large", "weight": "bold"}' \
  --block '{"text": "Uptime: 99.97%", "color": "#22C55E"}'

# Pipe a full JSON payload from stdin
echo '{"boardId":"my-board-id","blocks":[{"text":"From pipe"}]}' | pushtodisplay send --stdin

如果未提供 -b 標誌，服務器將使用你的默認顯示板。

樣式參數

面板參數

其他參數

boards

pushtodisplay boards list              # List all boards
pushtodisplay boards get <id>          # Get board details
pushtodisplay boards create -n "Name"  # Create a board
pushtodisplay boards create -n "Dash" -l 4  # Create with a layout
pushtodisplay boards delete <id>       # Delete a board

創建選項：

devices

pushtodisplay devices list    # List active device-board streams

config

pushtodisplay config              # Show current configuration
pushtodisplay config show         # Same as above

📤 JSON 輸出

為任何命令添加 --json 以獲得機器可讀輸出：

pushtodisplay boards list --json
pushtodisplay send -b my-board "test" --json

⚙️ 配置

配置按以下順序解析：環境變量 → 配置文件 → 默認值。

🤖 MCP 服務器

CLI 內置 Model Context Protocol 服務器，讓 AI 代理（Claude、Cursor、VS Code Copilot 等）直接訪問你的顯示板。

MCP 服務器會繼承你的 CLI 會話——如果你已運行 pushtodisplay auth login，它會自動完成認證。

設置

Claude Code

claude mcp add pushtodisplay -- npx pushtodisplay mcp

Claude Desktop

添加到 ~/Library/Application Support/Claude/claude_desktop_config.json（macOS）或 %APPDATA%\Claude\claude_desktop_config.json（Windows）：

{
  "mcpServers": {
    "pushtodisplay": {
      "command": "npx",
      "args": ["pushtodisplay", "mcp"]
    }
  }
}

Cursor

打開 Settings → MCP Servers → Add Server，或編輯 .cursor/mcp.json：

{
  "mcpServers": {
    "pushtodisplay": {
      "command": "npx",
      "args": ["pushtodisplay", "mcp"]
    }
  }
}

VS Code (GitHub Copilot)

添加到 .vscode/mcp.json：

{
  "servers": {
    "pushtodisplay": {
      "command": "npx",
      "args": ["pushtodisplay", "mcp"]
    }
  }
}

其他 MCP 客戶端

任何支持 stdio 傳輸的 MCP 客戶端都可以使用 Push To Display。服務器命令為：

npx pushtodisplay mcp

可用的 MCP 工具

🧭 命令速查

🔑 API 密鑰認證

對於無法進行交互式登錄的 CI/CD 流水線和腳本，你可以使用 API 密鑰進行認證。從移動應用或 Web 門戶 創建。API 密鑰以 pt_ 開頭。

# Via environment variable
export PTD_API_KEY=pt_your_key_here
pushtodisplay send "From CI"

# Or store in keychain
pushtodisplay auth login --api-key pt_your_key_here

注意： API 密鑰認證僅支持 send 命令。如需完整訪問顯示板、設備和配置管理，請使用 auth login。

🖼️ 截圖

4 面板佈局 —— 區域狀態一目瞭然

多面板展示 CI/CD 流水線和基礎設施日誌

帶顏色編碼嚴重級別的事件時間線

📄 許可證

MIT