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 프로파일링 — 자동 성능 프로파일링 설정