Superfid Docs
개발자 문서

Developer CLI

Superfid 외부 read API를 터미널에서 조회하는 CLI 사용법입니다.

Superfid Developer CLI는 외부 REST API를 호출하는 얇은 클라이언트입니다. 업무 계산이나 별도 캐시를 수행하지 않고 서버 DTO를 JSON 또는 안전한 table 출력으로 전달합니다.

다운로드와 설치

현재 CLI는 공개 npm 패키지로 배포하지 않고, production immutable release의 검증된 tarball로 배포합니다. 배포 완료 후 해당 release의 RELEASE_SHA를 받아 다음처럼 다운로드하고 SHA-256을 확인하세요.

export SUPERFID_RELEASE_SHA="<release-sha>"
export SUPERFID_CLI_RELEASE_URL="https://github.com/superfid/superfid-web/releases/download/deploy-${SUPERFID_RELEASE_SHA}"

curl --fail --location --remote-name-all \
  "$SUPERFID_CLI_RELEASE_URL/superfid-cli-0.1.0.tgz" \
  "$SUPERFID_CLI_RELEASE_URL/superfid-cli-0.1.0.tgz.sha256"
shasum -a 256 -c superfid-cli-0.1.0.tgz.sha256
npm install --global ./superfid-cli-0.1.0.tgz
superfid --version

운영체제별 standalone installer나 Homebrew/npm public publish는 아직 제공하지 않습니다. release 자산에 접근할 권한이 없는 사용자는 workspace 관리자에게 검증된 tarball을 받아야 합니다.

인증

배포된 CLI 패키지를 설치한 뒤, token은 표준 입력으로 전달하세요.

printf '%s' "$SUPERFID_DEVELOPER_KEY" | superfid auth set-token \
  --profile production \
  --base-url https://api.superfid.io \
  --environment prod \
  --token-stdin

토큰은 운영체제의 보안 credential store에 저장되고, CLI config에는 profile·base URL·workspace 식별자만 저장됩니다. SUPERFID_WORKSPACE_TOKEN과 SUPERFID_API_BASE_URL을 함께 지정하면 저장된 profile 없이 실행할 수도 있습니다.

조회 명령

superfid workspace current
superfid locations list
superfid inventory search --output json
superfid inventory status <sku-id> --output table
superfid inventory history <sku-id> --all --output json

--all은 cursor 페이지를 한 줄씩 JSON으로 출력하며 기본 최대 100페이지입니다. --max-pages로 상한을 낮출 수 있습니다. --output table은 사람이 읽는 용도이고 자동화에는 JSON을 사용하세요.

네트워크 동작

CLI는 HTTPS를 기본으로 사용하고 redirect 응답에서는 인증 헤더를 전달하지 않습니다. 408, 429, 502, 503, 504는 Retry-After를 존중해 제한적으로 재시도하며, 실패 시 안정적인 exit code와 비밀정보 없는 오류 메시지를 출력합니다.

On this page