CLI 가이드

@erdify/cli를 설치하면 터미널에서 다이어그램 조회·수정·DDL 추출을 바로 실행할 수 있습니다. 스크립트 자동화, CI/CD 파이프라인, AI 도구 셸 명령에 최적화되어 있습니다.

설치

Terminal 
npm install -g @erdify/cli

로그인

API 키를 config 파일에 저장합니다. 최초 1회만 실행하면 됩니다.

Terminal 
# API 키 직접 지정
erdify login --key erd_your_api_key_here

# 또는 대화형 입력
erdify login

# 현재 설정 확인
erdify whoami
환경변수 우선

ERDIFY_API_KEY 환경변수가 설정되어 있으면 config 파일보다 우선 적용됩니다. CI/CD에서 유용합니다.

조회

목록 조회

Terminal 
erdify list orgs                    # 조직 목록
erdify list projects <orgId>        # 프로젝트 목록
erdify list diagrams <projectId>    # 다이어그램 목록

다이어그램 상세 조회

Terminal 
erdify get diagram <diagramId>      # 테이블·컬럼·관계 요약
erdify get ddl <diagramId>          # DDL SQL 출력

수정

테이블

Terminal 
erdify add table <diagramId> <name>
erdify remove table <diagramId> <tableId>
# alias: erdify rm table ...

컬럼

Terminal 
# 추가
erdify add column <diagramId> <tableId> <name> \
  --type <type>         # SQL 타입 (필수): uuid, varchar, integer, timestamp ...
  [--pk]                # Primary Key
  [--not-null]          # NOT NULL
  [--unique]            # UNIQUE
  [--default <value>]   # 기본값

# 수정
erdify update column <diagramId> <tableId> <columnId> \
  [--name <name>]       # 컬럼명 변경
  [--type <type>]       # 타입 변경
  [--pk true|false]     # PK 설정/해제
  [--not-null true|false]
  [--unique true|false]
  [--default null]      # 기본값 제거

# 삭제
erdify remove column <diagramId> <tableId> <columnId>

관계 (FK)

Terminal 
# 추가
erdify add rel <diagramId> <srcTableId> <tgtTableId> <cardinality>
# cardinality: one-to-one | one-to-many | many-to-one

# 삭제
erdify remove rel <diagramId> <relationshipId>

실전 예시 — 결제 테이블 추가

Terminal 
# 1. 다이어그램 ID 확인
erdify list orgs
# my-org  (id: org_abc)
erdify list projects org_abc
# my-project  (id: proj_xyz)
erdify list diagrams proj_xyz
# main-erd  (id: diag_123, ...)

# 2. 현재 스키마 확인
erdify get diagram diag_123
# Tables (1):
#   users [tableId: tbl_users]

# 3. orders 테이블 추가
erdify add table diag_123 orders
# Table "orders" added. tableId=tbl_orders

# 4. 컬럼 추가
erdify add column diag_123 tbl_orders id --type uuid --pk --not-null
erdify add column diag_123 tbl_orders user_id --type uuid --not-null
erdify add column diag_123 tbl_orders total --type "decimal(10,2)" --not-null
erdify add column diag_123 tbl_orders created_at --type timestamp --not-null

# 5. FK 관계 설정 (orders → users)
erdify add rel diag_123 tbl_orders tbl_users many-to-one

# 6. DDL 확인
erdify get ddl diag_123

MCP vs CLI

MCP CLI
사용 방법 AI 도구에서 자연어 터미널 직접 실행
토큰 소모 높음 (프로토콜 오버헤드) 없음
자동화 제한적 스크립트 · CI/CD 가능
적합한 상황 AI와 대화하며 설계 반복 작업 · 파이프라인
← MCP 가이드 REST API →