Rayfin CLI 참조

프로젝트 생성, 스키마 변경 관리, Fabric 배포, 환경 설정 설정에 사용되는 Rayfin CLI 명령어를 찾아보세요. 각 섹션에는 명령어 문법, 옵션, 일반적인 용도가 나열되어 있습니다.

설치

CLI를 설치하는 데 사용 npm i @microsoft/rayfin-cli 하세요.

시작하기

터미널에서 Fabric 앱을 만들기 위해 단계를 따라가세요.

npm create @microsoft/rayfin@latest my-app  # 1. Create a project from a template
cd my-app
npx rayfin dev  # 2. Run the frontend dev server
npx rayfin up   # 3. Deploy to Microsoft Fabric

팁 (조언)

기존 또는 빈 프로젝트의 경우, npx rayfin init 이미 소스 코드나 빈 디렉터리가 있는 프로젝트에 Rayfin을 추가하는 대신 npm create 사용하세요. init 명령어는 서비스 활성화, 데이터베이스 방언 선택, 정적 호스팅 구성 과정을 새 템플릿 스캐폴딩 없이 안내해 줍니다.

전체 워크스루는 CLI로 첫 Fabric 앱을 생성하고 배포하고, Fabric 앱 배포 Fabric를 참조하세요.

스캐폴드 프로젝트, npm create

npm create (별칭) npm init Create initializer 패키지를 호출하여 새 프로젝트를 부트스트랩합니다. Fabric 앱을 스캐폴드로 만들려면 @microsoft/rayfin 초기화와 함께 사용하세요:

npm create @microsoft/rayfin@latest my-app --workspace <workspace name>

명령어 참조

이 글의 명령어와 플래그는 로컬에 설치된 CLI 도움말 출력에서 검증되었습니다.

최상위 명령

이 표를 사용해 적절한 명령을 빠르게 찾으세요.

Command 그걸 사용해
npx rayfin init [directory] Rayfin 프로젝트를 생성하거나 구성하세요.
npx rayfin connector Fabric 데이터 커넥터를 찾고, 구성하며, 검사하고, 호출하세요.
npx rayfin functions init Functions 패키지를 스캐폴드로 만들기.
npx rayfin dev 앱과 Functions를 로컬에서 실행하세요.
npx rayfin init ai-files Rayfin 에이전트 컨텍스트 파일을 설치하거나 확인하세요.
npx rayfin up 앱을 Fabric에 배포하고 원격 배포를 관리하세요.
npx rayfin env 에서 프레임 rayfin/.env워크별 환경 파일을 생성합니다.
npx rayfin login Rayfin 플랫폼에 로그인하세요.
npx rayfin logout 로그아웃하고 캐시된 자격 증명을 지우세요.

프로젝트 생성 또는 구성

rayfin init [directory]

Rayfin을 새 프로젝트나 기존 프로젝트에 추가할 때 사용 rayfin init 하세요.

Argument Description
--project-name <name> 프로젝트 이름을 설정하세요.
-t, --template <uri> 사용할 템플릿 URI를 지정하세요.
--template-name <name> 템플릿 이름을 선택하세요.
-l, --list-templates 사용 가능한 템플릿을 나열하세요.
--dialect <dialect> 데이터베이스 방언을 설정하세요.
--services <list> 어떤 서비스를 활성화할지 선택하세요.
--auth-methods <list> 인증 방법을 선택하세요.
--static-hosting 정적 호스팅 설정을 활성화하세요.
--overwrite 기존 생성된 파일을 덮어쓰세요.
--workspace-id <id> 특정 Fabric 작업 공간 ID를 사용하세요.
--workspace-uri <uri> 특정 Fabric 작업 공간 URI를 사용하세요.
--base-api-url <url> 기본 API URL을 덮어쓰세요.
--item-id <id> 특정 Fabric 아이템 ID를 타겟팅하세요.

Examples

스캐폴딩 전에 사용 가능한 템플릿을 나열하세요:

npx rayfin init --list-templates

현재 디렉터리에서 이름 있는 템플릿과 특정 방언을 사용하여 Rayfin을 초기화합니다:

npx rayfin init . --template-name react-vite --dialect mssql

서비스와 인증이 설정된 비인터랙티브적 새 프로젝트를 생성하세요:

npx rayfin init my-app --project-name my-app --services db,storage --auth-methods fabric --static-hosting --overwrite

커넥터 명령어

명령 그룹은 connector 외부 Fabric 데이터 소스를 관리합니다.

rayfin connector types

프로젝트에 추가할 수 있는 커넥터 유형을 나열합니다.

Option Description
--json 커넥터 타입 리스트를 JSON으로 내보냅니다.
-v, --verbose 능력 세부사항을 포함하세요.

rayfin connector search [query]

로그인한 신원이 커넥터로 추가할 수 있는 Fabric 소스를 검색합니다.

논증 또는 선택지 Description
[query] 선택 사항, 대소문자 구분 없는 소스명 필터.
--query <text> 이름이 붙은 소스-네임 필터가 우선순위를 차지 [query]합니다.
--type <type> 쉼표 구분된 커넥터 유형; 또는 .과 함께 --workspace-id--all-workspaces요구됨.
--workspace-id <id> Fabric 작업 공간 하나를 검색하세요.
--all-workspaces 신원이 접근할 수 있는 모든 작업 공간을 검색하세요.
-y, --yes 자동으로 인터랙티브 애드 핸드오프를 수락하세요.
--limit <n> 최대 결과 표시 수.
--output <interactive\|plain\|json> 출력 형식을 선택하세요.
--json 결과를 JSON으로 출력하고 인터랙티브 피커는 건너뛰세요.
-v, --verbose 자세한 정보 출력을 사용하도록 설정합니다.

두 작업 공간 옵션이 모두 제공되지 않으면, 명령어는 현재 프로젝트 배포에 기록된 작업 공간을 검색합니다.

rayfin connector add --type <type>

커넥터 선언을 추가하고 프로젝트 파일을 스캐폴드로 만듭니다.

Option Description
--type <type> 필수입니다. 커넥터 유형; 유형을 나열하는 데 사용됩니다 rayfin connector types .
--name <name> 커넥터 이름; 항목이 생략된 것에서 유래.
--workspace-id <id> Fabric 작업 공간 ID.
--item-id <id> Fabric 아이템 ID.
--operations <ops> 허용된 연산의 쉼표 구분 부분집합.
-v, --verbose 자세한 정보 출력을 사용하도록 설정합니다.
-y, --yes 자동 확인 수락.
--json JSON 출력을 내세요.

rayfin connector list

에 선 rayfin.yml언된 커넥터를 나열합니다.

Option Description
-v, --verbose 커넥터 메타데이터와 기능을 포함하세요.
--json JSON 출력을 내세요.

rayfin connector inspect

변경 없이 구성된 커넥터나 직접 주소 지정된 Fabric 소스를 검사합니다.

Option Description
--name <name> 커넥터 이름 설정 완료.
-w, --workspace <name> 직접 검사를 위한 작업 공간 이름.
--workspace-id <id> 직접 검사를 위한 작업 공간 ID.
--item <name> 직접 검사를 위한 항목 이름.
--item-id <id> 직접 검사용 아이템 식별 번호.
--type <type> 직접 검사용 커넥터 타입.
--url <url> 의미 모델 포털 URL; 작업 공간과 항목 ID를 파생합니다.
--entity <name> 샘플링할 엔티티나 테이블; 엔터티를 리스트하기 위해 생략합니다 --query .
--query <path> .sql .dax 또는 파일을 읽기 전용 모드로 실행할 수 있습니다.
--rows <n> 행 제한; 샘플은 기본값 10개이며 최대 100개로 제한됩니다.
-v, --verbose 자세한 정보 출력을 사용하도록 설정합니다.
--output <interactive\|plain\|json> 출력 형식을 선택하세요.
--json JSON 출력을 내세요.

구성 커넥터, 완전한 직접 소스 선택기, 또는 --url 의미론 모델에 사용됩니다--name.

rayfin connector invoke [connector-name] [operation]

설정된 커넥터에서 연산을 호출합니다.

논증 또는 선택지 Description
[connector-name] 커넥터 이름 설정 완료.
[operation] 커넥터 동작, 예를 들어 executeQuery.
--name <name> .[connector-name]
--operation <operation> .[operation]
--input <json> JSON 연산 입력.
--file <path> 작업 입력을 포함하는 JSON 파일.
--transport <auto\|deployed> 호출 경로; 기본값은 auto.
-v, --verbose 자세한 정보 출력을 사용하도록 설정합니다.
--output <interactive\|plain\|json> 출력 형식을 선택하세요.
--output-file <path> 전체 결과를 파일에 기록하세요.
--max-inline-bytes <bytes> 파일 작성을 위한 결과 크기 임계값; 기본값은 1 MiB입니다.
--json JSON 출력을 내세요.

rayfin connector remove <name>

커넥터 선언과 생성된 커넥터 파일을 제거합니다.

논증 또는 선택지 Description
<name> 필수입니다. 커넥터 이름을 제거해야 합니다.
-v, --verbose 자세한 정보 출력을 사용하도록 설정합니다.
-y, --yes 자동 삭제 확인 수락.
--json JSON 출력을 내세요.

함수 명령어

rayfin functions init [directory]

Functions 패키지를 스캐폴드하고 구성합니다.

논증 또는 선택지 Description
[directory] Project 루트; 기본값은 현재 디렉터리입니다.
--force 기존 Functions 스캐폴드를 덮어쓰세요.
--path <relative-path> 함수 패키지의 위치는 프로젝트 루트에 대해 상대적으로 사용됩니다.

패키지 위치는 기본적으로 감지된 작업 공간 위치 또는 rayfin/functions.

개발 명령

rayfin dev [project-path]

Rayfin 백엔드를 상대로 로컬 개발 세션을 시작합니다.

논증 또는 선택지 Description
[project-path] Project 루트; 기본값은 현재 디렉터리입니다.
--skip-db-apply 자동 데이터베이스 설정 건너뛰기, 적용하세요.
--env-file <path> .env 보간에 rayfin.yml 사용되는 파일.
--provider <fabric> 백엔드 제공자; 기본값은 fabric.
-w, --workspace <name> 첫 실행 백엔드를 위한 Fabric 작업 공간 이름입니다.
--workspace-id <id> 첫 실행 백엔드용 Fabric 작업 공간 ID.
--capacity-id <id> 사용 가능한 용량이 없는 작업 공간의 Fabric 용량 ID.
-t, --tenant <id> Microsoft Entra 테넌트 ID.
--encryption-fallback-enabled OS 키체인이 없을 때 평문 토큰 저장을 허용하세요.
--no-emit-env 프레임워크 .env.local 파일을 다시 생성하지 마세요.
-v, --verbose 자세한 로깅을 설정합니다.

rayfin dev functions apply

활성 배포에 대해 로컬 함수 호스트를 시작합니다.

Option Description
--port <port> 로컬 함수 호스트 포트; 기본값은 7071.
--inspect-port <port> Node.js 검사 포트; 기본값은 9229.
--no-debug Node.js 검사기를 비활성화하세요.
--no-emit-env 프레임워크 .env.local 파일을 다시 생성하지 마세요.
--verbose 진단 출력 표시.
--json JSON 출력을 내세요.
-y, --yes 인터랙티브 프롬프트 없이 실행하세요.

에이전트 파일 관리

이 명령어는 rayfin init ai-files 프로젝트 내 Rayfin 에이전트 컨텍스트 파일을 관리합니다: AGENTS.md, .mcp.json, 그리고 .agents/skills/rayfin/SKILL.md. CLI는 프로젝트를 스캐폴드할 때 이 파일들을 자동으로 설치합니다. 아래 명령어를 실행하여 기존 프로젝트에 설치하거나 새로고침하거나, 상태를 확인하세요.

rayfin init ai-files install

Rayfin 에이전트 파일을 설치하거나 새로고침합니다. 이 명령어는 멪등 명령어이며 기존 사용자 구성을 보존합니다.

Option Description
--enable <id> 특정 항목을 네임스페이스 ID로 설치하거나 유지하세요.skill:rayfin 반복.
--disable <id> 특정 항목을 파일을 삭제하지 않고 관리하는 것을 멈추세요. 반복.
--remove-files 항목을 비활성화할 때는 디스크 내 파일을 삭제하세요. --disable가 필요합니다.
--force [ids...] 수정된 아이템을 덮어쓰거나, 누락된 아이템을 복원하거나, 기형을 .mcp.json재건하는 등의 방법이 있습니다. 연산을 범위 설정하기 위해 선택적 네임스페이스 ID를 허용합니다. 절대 덮어쓰지 않습니다 AGENTS.md.
-n, --dry-run 파일을 작성하지 않고 변경 사항을 보고하세요.
--json JSON으로 구조화된 출력을 내보내고; 비인터랙티브 모드를 의미합니다.
-y, --yes, --non-interactive 인터랙티브 프롬프트는 건너뛰고 기본값을 받아들이세요.

예를 들어, 설치 기본값을 안내 없이 설정하세요:

npx rayfin init ai-files install --yes

rayfin init ai-files status

각 관리되는 에이전트 파일의 상태를 출력합니다. 구조화된 출력에 사용 --json 하세요.

가능한 상태에는 , , user-modified, , , , orphaned, 등이 unreadable포함됩니다up-to-date. disablednot-installedmissingupdate-available 파일을 새로고침하거나 rayfin init ai-files install --force <id> 특정 관리 항목을 덮어쓰기 위해 실행하세요rayfin init ai-files install.

Fabric 배포

rayfin up

rayfin up 사용해 애플리케이션을 Rayfin 항목으로 Fabric에 배포하세요.

Argument Description
-t, --tenant <id> 특정 세입자 ID를 사용하세요.
-w, --workspace <name> 이름별로 Fabric 작업 공간에 배포; 기본값은 My Workspace.
--workspace-id <id> 특정 Fabric 작업 공간 ID에 배포하세요.
--workspace-uri <uri> 특정 Fabric 작업 공간 URI에 배포하세요.
--item-name <name> Fabric 아이템 표시 이름; 기본적으로 프로젝트 ID입니다.
--capacity-id <id> 목표 작업 공간에 용량이 필요할 때 사용하는 Fabric 용량 ID.
--force 파괴적인 데이터 스키마 변경을 허용하세요.
-n, --dry-run 입력을 검증하고 배포하지 않고도 작업 공간을 해결하세요.
--env-file <path> .env 배포 속성에 대해 파일을 작성; 기본값은 rayfin/.env.
-v, --verbose 자세한 정보 출력을 사용하도록 설정합니다.
--json 배포 출력을 JSON 형식으로 반환하세요.
-y, --yes 자동 확인 수락.
--encryption-fallback-enabled OS 키체인이 없을 때 평문 토큰 저장을 허용하세요.
--exclude-services <names> 빌드 및 배포 중에 건너뛰는 쉼표 구분된 서비스: staticHosting 또는 functions.
--provider <fabric> 배포 제공자; 기본값은 fabric.

Examples

현재 선택된 Fabric 작업 공간에 배포하기:

npx rayfin up

적용하지 않고 배포 작업을 미리 보기:

npx rayfin up --dry-run --verbose

특정 작업 공간에 비인터랙티브로 배포하기:

npx rayfin up --workspace-id <workspace-id> --yes

기능을 구축하거나 배포하지 않고 배포하기:

npx rayfin up --exclude-services functions

--capacity-id, --workspace-id, , --workspace-uri와 결합--workspace할 수 없습니다.

하위 명령 Description
npx rayfin up db apply 원격 Rayfin 항목 작업 부하 엔드포인트에 DAB 구성을 생성하고 적용합니다.
npx rayfin up functions deploy 활성 원격 항목에 함수를 빌드, 패키징, 배포하세요.
npx rayfin up staticapp deploy 정적 콘텐츠를 원격 Rayfin 항목에 빌드, 패키징, 배포하세요.
npx rayfin up connector apply 선언된 GraphQL 커넥터에 대해 데이터베이스 구성을 적용합니다.
npx rayfin up status 현재 배치 상태를 표시하세요.
npx rayfin up list 프로젝트에 기록된 모든 Fabric 배포를 나열하세요.
npx rayfin up switch [workspace] 활성 Fabric 배포를 전환하고 rayfin/.env를 다시 쓰세요.

rayfin up db apply

원격 Rayfin 항목 워크로드 엔드포인트에 DAB 구성을 생성하고 적용합니다.

Argument Description
--verbose 자세한 출력 내용을 표시합니다.
--force 강제 재생 후 설정 적용.
--json 출력 반환은 JSON 형식으로 됩니다.

Examples

원격 Rayfin 항목에 데이터베이스 구성 변경 사항을 적용하기:

npx rayfin up db apply

강제 재생 및 기계 판독 출력 캡처:

npx rayfin up db apply --force --json

rayfin up functions deploy

활성 원격 항목에 함수를 빌드, 패키징, 배포합니다.

Option Description
--verbose 자세한 출력 내용을 표시합니다.
--skip-build 기존 함수 출력을 빌드하지 않고 배포하세요.
--json JSON 출력을 내세요.

rayfin up connector apply

선언된 GraphQL 커넥터에 대한 데이터베이스 구성을 적용합니다.

Option Description
--name <name> 이름이 붙은 커넥터만 적용하세요.
--verbose 자세한 정보 출력을 사용하도록 설정합니다.
--json JSON 출력을 내세요.

rayfin up staticapp deploy

정적 콘텐츠를 원격 Rayfin 항목에 빌드, 패키징, 배포합니다.

Argument Description
--verbose 자세한 출력 내용을 표시합니다.
--skip-build 빌드 단계를 실행하지 않고 배포하세요.
--json 출력 반환은 JSON 형식으로 됩니다.

Examples

정적 콘텐츠 구축 및 배포:

npx rayfin up staticapp deploy

빌드를 다시 실행하지 않고 미리 구축 dist 된 폴더를 배포하세요:

npx rayfin up staticapp deploy --skip-build

rayfin up status

클라우드 배포 상태를 표시합니다.

Argument Description
--json JSON 형식으로 상태 반환.
--verbose 자세한 출력 내용을 표시합니다.

Examples

현재 배치 상태를 확인하세요:

npx rayfin up status

스크립트에서 사용할 JSON으로 상태 반환:

npx rayfin up status --json

rayfin up list

이 프로젝트에 기록된 모든 Fabric 배포 목록을 나열합니다.

Argument Description
--json 배포 목록을 JSON 형식으로 반환하세요.

Examples

프로젝트에 기록된 모든 Fabric 배포 사례를 나열하세요:

npx rayfin up list

rayfin up switch [workspace]

활성 Fabric 배포를 전환하고 rayfin/.env를 그에 맞게 다시 작성합니다.

Argument Description
-l, --list 전환 없이 가능한 배치를 나열하세요.
--no-emit-env 방출된 환경 파일 작성은 건너뛰세요.

Examples

전환 가능한 배포 목록:

npx rayfin up switch --list

활성 배포를 특정 작업 공간으로 전환하세요:

npx rayfin up switch my-workspace

환경 파일 생성

rayfin env

에서 프레임워크 특화 rayfin env 값을 .env.local출력하는 데 사용 rayfin/.env 하세요.

Argument Description
--framework <vite|nextjs|plain> 목표 프레임워크 형식을 선택하세요.
--output <dir> 생성된 파일을 특정 디렉터리에 쓰세요.
--show 파일을 쓰지 않고 출력한 값들을 출력할 수 있습니다.

Examples

Vite와 호환 .env.local되는 생성 :

npx rayfin env --framework vite

파일을 쓰지 않고 출력 환경 값을 미리 보기:

npx rayfin env --framework nextjs --show

로그인 및 로그아웃

rayfin login

Rayfin 플랫폼에 로그인하는 데 사용 rayfin login 하세요.

Argument Description
--tenant <id> 특정 세입자 ID를 사용하세요.
--service-principal 서비스 주인 로그인 시도. 이 옵션은 도움말에 나와 있지만 현재 지원되지 않습니다.
-u, --client-id <id> 서비스 책임자 로그인을 위해 클라이언트 ID를 제공하세요. 이 옵션은 도움말에 나와 있지만 현재 지원되지 않습니다.
-p, --client-secret <secret> 서비스 책임자 로그인을 위한 클라이언트 비밀을 제공하세요. 이 옵션은 도움말에 나와 있지만 현재 지원되지 않습니다.
--select 로그인된 계정이나 상황에서 선택할 수 있습니다.
--encryption-fallback-enabled 암호화 백업 동작을 활성화하세요.

Examples

인터랙티브로 로그인하기:

npx rayfin login

특정 세입자에 로그인하기:

npx rayfin login --tenant 00000000-0000-0000-0000-000000000000

로그인 계정 간 전환:

npx rayfin login --select
하위 명령 Description
npx rayfin login status 현재 인증 상태를 표시하세요.

rayfin login status

현재 인증 상태를 표시합니다.

Argument Description
없음 이 하위 명령어는 CLI 도움말 출력에 어떤 옵션도 나열하지 않습니다.

Example

로그인 여부를 확인하세요:

npx rayfin login status

rayfin logout

로그아웃하고 캐시된 자격 증명을 삭제합니다.

Argument Description
없음 이 명령어는 CLI 도움말 출력에 어떤 옵션도 나열하지 않습니다.

Example

로그아웃 후 캐시된 자격 증명을 삭제하세요:

npx rayfin logout