跳到內容
Framedash Docs

CLI 參考

Framedash CLI 提供從終端機存取遙測資料、分析和專案管理的功能。支援在 CI/CD 管線中自動上傳地圖和同步內容。

安裝

Section titled “安裝”
Terminal window
npm install -g @framedash/cli

驗證

Section titled “驗證”

透過環境變數設定 API 金鑰：

Terminal window
export FRAMEDASH_API_KEY=fd_your_api_key_here

或使用 --api-key 明確傳遞：

Terminal window
framedash status --api-key fd_your_api_key_here

驗證金鑰是否有效：

Terminal window
framedash auth

共用選項

Section titled “共用選項”

大多數指令接受以下選項：

選項說明
--api-key <key>API 金鑰（或 FRAMEDASH_API_KEY 環境變數）
--project-id <uuid>專案 ID（或 FRAMEDASH_PROJECT_ID 環境變數）
--base-url <url>API 主機 URL（預設：https://app.framedash.dev）
--format <fmt>輸出格式：json、table、csv（預設：json）
-h, --help顯示說明

指令

Section titled “指令”

framedash auth

Section titled “framedash auth”

驗證 API 金鑰並顯示關聯的專案。

Terminal window
framedash auth

選項：--api-key、--base-url、--format

framedash status

Section titled “framedash status”

顯示專案健康狀態。

Terminal window
framedash status

framedash dashboard

Section titled “framedash dashboard”

顯示儀表板 KPI（DAU、MAU、工作階段、事件數）。

Terminal window
framedash dashboard --days 30
選項值預設值
--days7, 14, 30, 9030

framedash retention

Section titled “framedash retention”

顯示玩家留存率世代（D1、D7、D30）。

Terminal window
framedash retention --days 14
選項值預設值
--days7, 14, 30, 9030

framedash funnel

Section titled “framedash funnel”

分析事件漏斗，衡量各步驟之間的玩家轉換率。

Terminal window
framedash funnel --steps "player.spawn,player.death,player.respawn"
選項說明預設值
--steps逗號分隔的事件名稱（必要，2-8 個步驟）—
--window時間窗口（秒）：3600、21600、86400、60480086400
--days時間範圍：7、14、30、9030

framedash query

Section titled “framedash query”

對遙測資料執行 SQL 查詢。

Terminal window
# 內嵌 SQL
framedash query "SELECT event_name, count() FROM events GROUP BY event_name"


# 從檔案讀取
framedash query --file ./queries/daily-active.sql
選項說明
--file <path>從檔案讀取 SQL 而非內嵌參數
--limit <n>傳回的最大列數

framedash alerts

Section titled “framedash alerts”

管理效能警示規則。

Terminal window
# 警示規則清單
framedash alerts list


# 建立新警示規則
framedash alerts create --name "FPS Alert" --map-id <uuid> \
  --threshold-profile-id <uuid> --metric fps


# 更新警示規則
framedash alerts update <alert-id> --name "Updated Alert"


# 停用警示規則
framedash alerts delete <alert-id>

framedash maps

Section titled “framedash maps”

管理遊戲地圖。

Terminal window
# 地圖清單
framedash maps list


# 透過地圖識別碼刪除
framedash maps delete <map-id>

framedash map-capture

Section titled “framedash map-capture”

上傳擷取的地圖影像。此指令使用獨立的選項解析器，不使用共享的全域選項。

Terminal window
# 上傳預覽（模擬執行）
framedash map-capture --input-dir ./captures --upload --dry-run


# 上傳地圖擷取
framedash map-capture --input-dir ./captures --upload \
  --api-key fd_xxx --project-id <uuid>
選項說明
--input-dir <path>擷取影像目錄（必要）
--upload實際執行上傳（必要）
--api-key <key>上傳用 API 金鑰
--project-id <uuid>目標專案
--base-url <url>API 基礎 URL
--dry-run預覽但不傳送

framedash content

Section titled “framedash content”

管理內容註冊表（物品、武器、事件類型等）。

Terminal window
# 內容項目清單
framedash content list


# 從 JSON 檔案匯入內容
framedash content import ./game-content.json


# 透過 UUID 刪除
framedash content delete <uuid>


# 透過類型和內容 ID 刪除
framedash content delete --type weapon --content-id ak47

在 CI/CD 中使用

Section titled “在 CI/CD 中使用”

GitHub Actions 範例：

- name: Upload maps and import content
  env:
    FRAMEDASH_API_KEY: ${{ secrets.FRAMEDASH_API_KEY }}
    FRAMEDASH_PROJECT_ID: ${{ vars.PROJECT_ID }}
  run: |
    framedash map-capture --input-dir ./map-captures --upload
    framedash content import ./game-content.json

Jenkins 及 TeamCity 範例請參閱 CI/CD 整合指南。

下一步

Section titled “下一步”