CLI リファレンス

Framedash CLI は、ターミナルからテレメトリデータ・アナリティクス・プロジェクト管理にアクセスできるツールです。CI/CD パイプラインでのマップアップロードやコンテンツ同期にも対応しています。

インストール

npm install -g @framedash/cli

認証

環境変数で API キーを設定:

export FRAMEDASH_API_KEY=fd_your_api_key_here

または --api-key オプションで直接指定:

framedash status --api-key fd_your_api_key_here

キーの有効性を確認:

framedash auth

共通オプション

ほとんどのコマンドで以下のオプションが使用できます:

オプション	説明
`--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`	ヘルプを表示

コマンド

`framedash auth`

API キーの検証と紐付けプロジェクトの表示。

framedash auth

オプション: --api-key, --base-url, --format

`framedash status`

プロジェクトのヘルスステータスを表示。

framedash status

`framedash dashboard`

ダッシュボード KPI（DAU、MAU、セッション、イベント数）を表示。

framedash dashboard --days 30

オプション	値	デフォルト
`--days`	7, 14, 30, 90	30

`framedash retention`

プレイヤーリテンションコホート（D1、D7、D30）を表示。

framedash retention --days 14

オプション	値	デフォルト
`--days`	7, 14, 30, 90	30

`framedash funnel`

イベントファネルを分析し、ステップ間のプレイヤーコンバージョンを測定。

framedash funnel --steps "player.spawn,player.death,player.respawn"

オプション	説明	デフォルト
`--steps`	カンマ区切りのイベント名（必須、2-8 ステップ）	—
`--window`	タイムウィンドウ（秒）: 3600, 21600, 86400, 604800	86400
`--days`	期間: 7, 14, 30, 90	30

`framedash query`

テレメトリデータに対する SQL クエリを実行。

# インライン 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`

パフォーマンスアラートルールの管理。

# アラートルール一覧
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`

ゲームマップの管理。

# マップ一覧
framedash maps list

# マップ ID でマップを削除
framedash maps delete <map-id>

`framedash map-capture`

キャプチャしたマップ画像をアップロード。このコマンドは独自のオプションパーサーを持ち、共通グローバルオプションは使用しません。

# アップロード内容のプレビュー（ドライラン）
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`

コンテンツレジストリ（アイテム、武器、イベント種別など）の管理。

# コンテンツエントリ一覧
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 での使用

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 統合ガイドを参照してください。

次のステップ

API リファレンス — REST API の詳細
CI/CD 統合 — Jenkins および TeamCity パイプライン例
CI プロファイリング — 自動パフォーマンスプロファイリング設定