Referência da CLI Rayfin

Encontre os comandos da CLI do Rayfin para criar projetos, gerir alterações de esquema, implementar para o Fabric e configurar as definições do ambiente. Cada secção lista a sintaxe dos comandos, opções e usos comuns.

Instalação

Uso npm i @microsoft/rayfin-cli para instalar o CLI.

Como Começar

Siga os passos no seu terminal para criar uma aplicação 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

Sugestão

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-o na ativação dos serviços, na escolha de um dialeto da base de dados e na configuração do alojamento estático sem estruturar um novo modelo.

Para o guia completo, consulte Criar e implementar a sua primeira aplicação Fabric com a CLI e Deploye uma aplicação Fabric para Fabric.

Andaime um projeto com npm create

npm create (pseudónimo de npm init) inicia um novo projeto invocando um pacote Create Initializer. Para andar uma aplicação Fabric, use-a com o inicializador @microsoft/rayfin:

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

Referência de comando

Os comandos e flags neste 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 Usa-o para
rayfin init [directory] Crie ou configure um projeto Rayfin.
rayfin up Implementa a aplicação no Fabric e gere implementações remotas.
rayfin env Gerar ficheiros de ambiente específicos do framework a partir de rayfin/.env.
rayfin login Inicie sessão na plataforma Rayfin.
rayfin logout Sai e limpa as credenciais em cache.

Criar ou configurar um projeto

rayfin init [directory]

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

Argument Descrição
--project-name <name> Define o nome do projeto.
-t, --template <uri> Especifique o URI do modelo a usar.
--template-name <name> Selecione um modelo pelo nome.
-l, --list-templates Lista os modelos disponíveis.
--dialect <dialect> Define o dialeto da base de dados.
--services <list> Escolha quais os serviços a disponibilizar.
--auth-methods <list> Escolha métodos de autenticação.
--static-hosting Ativa a configuração de alojamento estático.
--overwrite Sobrescrever ficheiros gerados existentes.
--workspace-id <id> Use um ID específico de espaço de trabalho Fabric.
--workspace-uri <uri> Usa um URI específico do Fabric workspace.
--base-api-url <url> Sobrescrever a URL base da API.
--item-id <id> Foca num ID específico do item Fabric.

Examples

Liste os modelos disponíveis antes de a estrutura:

npx rayfin init --list-templates

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

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

Criar um novo projeto de forma não interativa 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

Deploy to Fabric

rayfin up

Use rayfin up para implementar a aplicação para Fabric como um item Rayfin.

Argument Descrição
--tenant <id> Use um ID de inquilino específico.
--workspace-id <id> Implemente para um ID específico de espaço de trabalho Fabric.
--workspace-uri <uri> Implemente para um URI específico do espaço de trabalho Fabric.
--base-api-url <url> Sobrescrever a URL base da API.
--force Medidas de desdobramento de força quando necessário.
--dry-run Pré-visualizar as ações de implementação sem as aplicar.
--env-file <path> Carregar valores do ambiente a partir de um ficheiro.
--verbose Mostrar uma saída de implementação detalhada.
--json Devolva a saída de implementação em formato JSON.
-y, --yes Aceita os prompts automaticamente.
--encryption-fallback-enabled Ativar o comportamento de encriptação.

Examples

Implementar no espaço de trabalho Fabric atualmente selecionado:

npx rayfin up

Pré-visualize as ações de implementação sem as aplicar:

npx rayfin up --dry-run --verbose

Implemente para um espaço de trabalho específico de forma não interativa:

npx rayfin up --workspace-id 00000000-0000-0000-0000-000000000000 --yes
Subcomando Descrição
rayfin up db apply Gerar e aplicar configuração DAB ao endpoint remoto da carga de trabalho do item Rayfin.
rayfin up staticapp deploy Construa, empacota e implemente conteúdo estático para o item remoto do Rayfin.
rayfin up status Mostrar o estado atual da implantação.
rayfin up list Liste todas as implementações de Fabric registadas para o projeto.
rayfin up switch [workspace] Muda a ativa Fabric deployment e reescreve rayfin/.env.

rayfin up db apply

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

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

Examples

Aplicar alterações na configuração da base 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 implementa conteúdo estático no item remoto do Rayfin.

Argument Descrição
--verbose Mostrar saída detalhada.
--skip-build Implemente sem executar a etapa de construção.
--json Devolver a saída em formato JSON.

Examples

Construir e implementar conteúdo estático:

npx rayfin up staticapp deploy

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

npx rayfin up staticapp deploy --skip-build

rayfin up status

Mostra o estado da implementação na cloud.

Argument Descrição
--json Estado do retorno em formato JSON.
--verbose Mostrar saída detalhada.

Examples

Verifique o estado atual da implementação:

npx rayfin up status

Estado de retorno como JSON para uso em scripts:

npx rayfin up status --json

rayfin up list

Lista todas as implementações Fabric registadas para este projeto.

Argument Descrição
--json Devolva a lista de implementação em formato JSON.

Examples

Liste todas as implementações Fabric registadas para o projeto:

npx rayfin up list

rayfin up switch [workspace]

Muda o ativo Fabric implementação e reescreve rayfin/.env em conformidade.

Argument Descrição
-l, --list Liste as implementações disponíveis sem necessidade de mudar.
--no-emit-env Ignora a escrita de ficheiros de ambiente emitidos.

Examples

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

npx rayfin up switch --list

Mude a implementação ativa para um espaço de trabalho específico:

npx rayfin up switch my-workspace

Gerar ficheiros de ambiente

rayfin env

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

Argument Descrição
--framework <vite|nextjs|plain> Escolha o formato do framework de destino.
--output <dir> Escreve ficheiros gerados num diretório específico.
--show Imprimir valores emitidos sem escrever ficheiros.

Examples

Gerar um Vite-compatível .env.local:

npx rayfin env --framework vite

Pré-visualização emitiu valores de ambiente sem escrever ficheiros:

npx rayfin env --framework nextjs --show

Entrar e sair da sessão

rayfin login

Use rayfin login para iniciar sessão na plataforma Rayfin.

Argument Descrição
--tenant <id> Use um ID de inquilino específico.
--service-principal Tente iniciar sessão com o principal do serviço. Esta opção está listada na ajuda, mas atualmente não é suportada.
-u, --client-id <id> Forneça o ID do cliente para o início de sessão do principal de serviço. Esta opção está listada na ajuda, mas atualmente não é suportada.
-p, --client-secret <secret> Forneça ao cliente o principal secreto para o serviço. Esta opção está listada na ajuda, mas atualmente não é suportada.
--select Selecione entre contas ou contextos ligados disponíveis.
--encryption-fallback-enabled Ativar o comportamento de encriptação.

Examples

Iniciar sessão interativamente:

npx rayfin login

Inicie sessão num inquilino específico:

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

Alterne entre contas iniciadas:

npx rayfin login --select
Subcomando Descrição
rayfin login status Mostrar o estado atual da autenticação.

rayfin login status

Mostra o estado atual de autenticação.

Argument Descrição
None Este subcomando não lista quaisquer opções na saída de ajuda da CLI.

Example

Verifica se estás com sessão iniciada:

npx rayfin login status

rayfin logout

Desliga-se e limpa as credenciais em cache.

Argument Descrição
None Este comando não lista nenhuma opção na saída de ajuda da CLI.

Example

Sair e limpar as credenciais em cache:

npx rayfin logout
  • Last updated on