Referência da CLI Rayfin

Encontre os comandos da CLI do Rayfin para criar projetos, gerenciar mudanças de esquema, implantar no Fabric e configurar configurações do ambiente. Cada seção lista a sintaxe dos comandos, opções e usos comuns.

Installation

Use npm i @microsoft/rayfin-cli para instalar a linha de código.

Como começar

Siga os passos no seu terminal para criar um aplicativo Fabric.

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

Dica

Para projetos existentes ou vazios, use npx rayfin init em vez de npm create adicionar o Rayfin a um projeto que já tenha código-fonte ou um diretório vazio. O comando init guia você pela habilitação dos serviços, escolha de um dialeto de banco de dados e configuração de hospedagem estática sem estruturar um novo modelo.

Para o guia completo, veja Crie e implante seu primeiro aplicativo Fabric com a CLI e Implante um aplicativo Fabric para Fabric.

Estrutura um projeto com npm create

npm create (pseudônimo de npm init) inicia um novo projeto invocando um pacote de inicializador create. Para andar um aplicativo Fabric, use-o com o inicializador @microsoft/rayfin:

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

Referência do comando

Os comandos e flags deste artigo foram verificados a partir da saída de ajuda da CLI instalada localmente.

Comandos de nível superior

Use esta tabela para encontrar rapidamente o comando certo.

Comando	Utilize-o para
rayfin init [directory]	Crie ou configure um projeto Rayfin.
rayfin up	Implante o aplicativo no Fabric e gerencie implantações remotas.
rayfin env	Gerar arquivos de ambiente específicos do framework a partir de rayfin/.envarquivos de .
rayfin login	Faça login na plataforma Rayfin.
rayfin logout	Faça logout e limpe as credenciais em cache.

Crie ou configure um projeto

rayfin init [directory]

Use rayfin init para adicionar Rayfin a um projeto novo ou existente.

Argument	Description
--project-name <name>	Defina o nome do projeto.
-t, --template <uri>	Especifique o URI do modelo a ser usado.
--template-name <name>	Selecione um modelo pelo nome.
-l, --list-templates	Liste os modelos disponíveis.
--dialect <dialect>	Defina o dialeto do banco de dados.
--services <list>	Escolha quais serviços disponibilizar.
--auth-methods <list>	Escolha métodos de autenticação.
--static-hosting	Ative a configuração de hospedagem estática.
--overwrite	Sobrescreva arquivos gerados existentes.
--workspace-id <id>	Use um ID específico de espaço de trabalho Fabric.
--workspace-uri <uri>	Use um URI específico do Fabric workspace.
--base-api-url <url>	Substitua a URL base da API.
--item-id <id>	Foque em um ID específico do item Fabric.

Examples

Liste os modelos disponíveis antes de montar a estrutura:

npx rayfin init --list-templates

Inicialize o Rayfin no diretório atual usando um template nomeado e um dialeto específico:

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

Crie um novo projeto não interativamente com serviços e autenticação configurados:

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

Implantar no Fabric

rayfin up

Use rayfin up para implantar a aplicação em Fabric como um item do Rayfin.

Argument	Description
--tenant <id>	Use um ID específico de inquilino.
--workspace-id <id>	Implante em um ID específico de espaço de trabalho Fabric.
--workspace-uri <uri>	Implante em um URI específico do espaço de trabalho Fabric.
--base-api-url <url>	Substitua a URL base da API.
--force	Passos de implantação forçada quando necessário.
--dry-run	Pré-visualize as ações de implantação sem aplicá-las.
--env-file <path>	Carregar valores do ambiente a partir de um arquivo.
--verbose	Mostre a saída detalhada da implantação.
--json	Devolva a saída de implantação em formato JSON.
-y, --yes	Aceito os prompts automaticamente.
--encryption-fallback-enabled	Ative o comportamento de respaldo da criptografia.

Examples

Implantar no espaço de trabalho Fabric atualmente selecionado:

npx rayfin up

Pré-visualize as ações de implantação sem aplicá-las:

npx rayfin up --dry-run --verbose

Implante em um espaço de trabalho específico de forma não interativa:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes

Subcommand	Description
rayfin up db apply	Gerar e aplicar a configuração do DAB ao endpoint remoto da carga de trabalho do item Rayfin.
rayfin up staticapp deploy	Construa, empacote e implante conteúdo estático no item remoto do Rayfin.
rayfin up status	Mostre o status atual da implantação.
rayfin up list	Liste todas as implantações Fabric registradas para o projeto.
rayfin up switch [workspace]	Alterne a Fabric ativa de implantação e reescreva rayfin/.env.

rayfin up db apply

Gera e aplica a configuração DAB ao endpoint remoto da carga de trabalho do item Rayfin.

Argument	Description
--verbose	Mostrar a saída verbosa.
--force	Forçar a regeneração e aplicar a configuração.
--json	Devolver a saída em formato JSON.

Examples

Aplique alterações na configuração do banco de dados ao item remoto do Rayfin:

npx rayfin up db apply

Regeneração forçada e captura de saída legível por máquina:

npx rayfin up db apply --force --json

rayfin up staticapp deploy

Constrói, empacota e implanta conteúdo estático no item remoto do Rayfin.

Argument	Description
--verbose	Mostrar a saída verbosa.
--skip-build	Implante sem rodar a etapa de build.
--json	Devolver a saída em formato JSON.

Examples

Construa e implante conteúdo estático:

npx rayfin up staticapp deploy

Implante uma pasta pré-construída dist sem reexecutar a compilação:

npx rayfin up staticapp deploy --skip-build

rayfin up status

Exibe o status da implantação na nuvem.

Argument	Description
--json	Status do retorno em formato JSON.
--verbose	Mostrar a saída verbosa.

Examples

Verifique o status atual da implantação:

npx rayfin up status

Status de retorno como JSON para uso em scripts:

npx rayfin up status --json

rayfin up list

Lista todas as implantações do Fabric registradas para este projeto.

Argument	Description
--json	Devolva a lista de implantação em formato JSON.

Examples

Liste todas as implantações Fabric registradas para o projeto:

npx rayfin up list

rayfin up switch [workspace]

Muda a implantação ativa Fabric e reescreve rayfin/.env conforme corresponde.

Argument	Description
-l, --list	Liste as implantações disponíveis sem mudar.
--no-emit-env	Pule a gravação dos arquivos de ambiente emitidos.

Examples

Lista de implantações disponíveis para mudar:

npx rayfin up switch --list

Mudar a implantação ativa para um espaço de trabalho específico:

npx rayfin up switch my-workspace

Gerar arquivos de ambiente

rayfin env

Use rayfin env para emitir valores específicos .env.local do framework a partir de rayfin/.env.

Argument	Description
--framework <vite|nextjs|plain>	Escolha o formato do framework de destino.
--output <dir>	Escreva arquivos gerados em um diretório específico.
--show	Imprimir valores emitidos sem escrever arquivos.

Examples

Gerar um compatível .env.localcom Vite:

npx rayfin env --framework vite

Pré-visualização emitia valores do ambiente sem escrever arquivos:

npx rayfin env --framework nextjs --show

Entrar e sair

rayfin login

Use rayfin login para fazer login na plataforma Rayfin.

Argument	Description
--tenant <id>	Use um ID específico de inquilino.
--service-principal	Tente fazer login com o principal do serviço. Essa opção está listada na ajuda, mas atualmente não é suportada.
-u, --client-id <id>	Forneça o ID do cliente para o login do principal de serviço. Essa opção está listada na ajuda, mas atualmente não é suportada.
-p, --client-secret <secret>	Forneça ao cliente o principal de registro secreto para o serviço. Essa opção está listada na ajuda, mas atualmente não é suportada.
--select	Selecione entre contas ou contextos logados disponíveis.
--encryption-fallback-enabled	Ative o comportamento de respaldo da criptografia.

Examples

Faça login interativamente:

npx rayfin login

Faça login com um inquilino específico:

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

Alterne entre contas logadas:

npx rayfin login --select

Subcommand	Description
rayfin login status	Exiba o status atual de autenticação.

rayfin login status

Exibe o status atual de autenticação.

Argument	Description
Nenhum	Este subcomando não lista nenhuma opção na saída de ajuda da CLI.

Exemplo

Verifique se você está logado:

npx rayfin login status

rayfin logout

Faz login e limpa credenciais em cache.

Argument	Description
Nenhum	Esse comando não lista nenhuma opção na saída de ajuda da CLI.

Exemplo

Saia e limpe as credenciais em cache:

npx rayfin logout