Cli

🚀 Push To Display CLI

ターミナルやAIエージェントからディスプレイボードへリアルタイム更新を送信するコマンドラインインターフェース & MCPサーバー

Push To Display 向けの公式CLIです。ターミナルから直接、あるいはAIエージェント経由で表示ボードへリアルタイムに情報を配信できます。

📦 インストール

npx で直接実行（インストール不要）:

npx pushtodisplay --help

またはグローバルにインストール:

npm install -g pushtodisplay

📌 動作要件

• Node.js 18 以上

ガイド、ユースケース、APIの詳細については PushToDisplay ドキュメント を参照してください。

🚀 クイックスタート

# ログイン（ブラウザが開きます）
pushtodisplay auth login

# 更新を送信（デフォルトのボードを使用）
pushtodisplay send "Hello, Display!"

# 特定のボードへ送信
pushtodisplay send -b <board-id> "Deploy completed"

# ボード一覧を表示
pushtodisplay boards list

🔐 認証

Push To Display アカウントでログインします。モバイルアプリと同じアカウントを使用します。

🌐 ブラウザログイン（デフォルト）

pushtodisplay auth login

ブラウザが起動します。サインインすると、CLIが自動的に認証情報を受け取ります。

💻 デバイスコードログイン（ヘッドレス環境向け）

ブラウザのない環境 — SSHセッション、コンテナ、リモートサーバーなど — での利用に適しています。

pushtodisplay auth login --device-code

CLIにURLとワンタイムコードが表示されます。任意のデバイスでURLを開き、コードを入力してログインを承認してください。

💡 認証情報の保存場所

認証情報はOSのキーチェーン（macOS Keychain、Linux libsecret、Windows Credential Manager）に保存されます。キーチェーンが利用できない場合は ~/.config/pushtodisplay/ にフォールバックします。

# 認証ステータスを確認
pushtodisplay auth status

# ログアウト（保存された認証情報をクリア）
pushtodisplay auth logout

🛠️ コマンド

send

ボードへディスプレイ更新を送信します。

# シンプルなテキスト
pushtodisplay send -b my-board-id "Deploy succeeded"

# スタイル付きテキスト
pushtodisplay send -b my-board-id "Status" --size large --weight bold --color "#00FF00"

# 複数ブロック
pushtodisplay send -b my-board-id "Build:" "passing" --color "#22C55E"

# パネル指定とレイアウトオプション
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"

# JSONによるブロック単位のスタイル指定（繰り返し可能）
pushtodisplay send -b my-board-id \
  --block '{"text": "API Health", "size": "large", "weight": "bold"}' \
  --block '{"text": "Uptime: 99.97%", "color": "#22C55E"}'

# stdinから完全なJSONペイロードをパイプ
echo '{"boardId":"my-board-id","blocks":[{"text":"From pipe"}]}' | pushtodisplay send --stdin

💡 -b フラグを指定しない場合、サーバーはデフォルトのボードを使用します。

🎨 スタイルフラグ

🖼️ パネルフラグ

⚙️ その他のフラグ

boards

pushtodisplay boards list                    # すべてのボードを一覧表示
pushtodisplay boards get <id>                # ボードの詳細を取得
pushtodisplay boards create -n "Name"        # ボードを作成
pushtodisplay boards create -n "Dash" -l 4   # レイアウトを指定して作成
pushtodisplay boards delete <id>             # ボードを削除

作成オプション:

devices

pushtodisplay devices list    # アクティブなデバイス-ボードストリームを一覧表示

config

pushtodisplay config          # 現在の設定を表示
pushtodisplay config show     # 上記と同じ

📊 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

macOSの場合は ~/Library/Application Support/Claude/claude_desktop_config.json、Windowsの場合は %APPDATA%\Claude\claude_desktop_config.json に追加:

{
  "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キーによる認証が可能です。APIキーはモバイルアプリまたはWebポータルから作成できます。APIキーは pt_ で始まります。

# 環境変数経由
export PTD_API_KEY=pt_your_key_here
pushtodisplay send "From CI"

# またはキーチェーンに保存
pushtodisplay auth login --api-key pt_your_key_here

⚠️ 注意

APIキー認証は send コマンドのみをサポートしています。ボード、デバイス、設定管理のすべてにアクセスするには auth login を使用してください。

📸 スクリーンショット

4パネルレイアウト — 地域ステータスを一目で把握

CI/CDパイプラインとインフラログを表示するマルチパネル

重要度を色分けしたインシデントタイムライン

📄 ライセンス

MIT