SDK와 CLI

타입 지정 클라이언트

타입 지정 클라이언트는 @foir/sdk 패키지에 있으며, 다른 클라이언트와 같은 엔드포인트로 GraphQL을 보내고 문서를 대신 작성해 줍니다. 타입 지정 호출 하나가 요청 하나입니다. 기본적으로 모델의 모든 스칼라 필드를 반환하며, pick, omit, include로 선택을 조정합니다.

타입은 foir types 명령에서 나오며 키별로 생성되므로 키가 수행할 수 없는 오퍼레이션은 타입에 없습니다.

클라이언트가 실행되는 곳

클라이언트는 fetch만 사용하며 모듈 수준 상태를 갖지 않습니다. 문서에서는 Hydrogen, React Router 로더, TanStack Start, 엣지 런타임에서의 사용을 다룹니다. 같은 패키지의 다른 진입점은 사용자의 세션, 실시간 업데이트 및 미디어를 처리합니다.

CLI가 다루는 범위

@foir/cli 패키지는 foir 명령을 설치합니다. 명령 그룹은 레코드, 모델, 로케일, 미디어, 검색, 롤아웃, 릴리스, 캐시, API 키, 사용자와 그 역할, 조직, 오퍼레이션, 훅, 스케줄, 시크릿, 로그인 공급자, 내보내기, 타입 생성을 다룹니다. 또한 푸시를 통해 설정 파일을 적용합니다. CLI 레퍼런스에 명령 목록이 있으며, 문서의 인텐트 레퍼런스에서 어떤 플랫폼 작업에 명령이 있는지 확인할 수 있습니다.

스크립트용 출력과 로그인

모든 명령은 기본적으로 표를 출력하며, 파이프용으로 JSON, JSON Lines 또는 id만 출력할 수 있습니다. 페이로드는 플래그, 파일, stdin으로 전달합니다. 브라우저로 로그인하거나, SSH, 컨테이너, CI에서는 디바이스 코드 플로우를 사용하며, 헤드리스 실행에서는 환경 변수에 API 키를 설정합니다.