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
npx rayfin 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
npx rayfin init [directory] Crie ou configure um projeto Rayfin.
npx rayfin connector Encontre, configure, inspecione e invoque conectores de dados Fabric.
npx rayfin functions init Estrutura um pacote de Funções.
npx rayfin dev Execute o app e as Funções localmente.
npx rayfin init ai-files Instale ou verifique os arquivos de contexto do agente Rayfin.
npx rayfin up Implante o aplicativo no Fabric e gerencie implantações remotas.
npx rayfin env Gerar arquivos de ambiente específicos do framework a partir de rayfin/.envarquivos de .
npx rayfin login Faça login na plataforma Rayfin.
npx 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

Comandos de conexão

O connector grupo de comando gerencia fontes externas de dados Fabric.

rayfin connector types

Lista tipos de conectores que você pode adicionar a um projeto.

Opção Description
--json Emita a lista de tipos de conectores como JSON.
-v, --verbose Inclua detalhes de capacidades.

rayfin connector search [query]

Searches Fabric fornece fontes que a identidade logada pode adicionar como conectores.

Argumento ou opção Description
[query] Filtro opcional, insensível a maiúsculas e minúsculas, com nome de fonte.
--query <text> Filtro nomeado de nome de fonte que tem precedência sobre [query].
--type <type> Tipos de conectores separados por vírgula; exigidos com --workspace-id ou --all-workspaces.
--workspace-id <id> Procure em um espaço de trabalho Fabric.
--all-workspaces Pesquise em todos os espaços de trabalho que a identidade pode acessar.
-y, --yes Aceite automaticamente a transferência interativa de adição.
--limit <n> Número máximo de resultados exibidos.
--output <interactive\|plain\|json> Selecione o formato de saída.
--json Imprima os resultados como JSON e pule o seletor interativo.
-v, --verbose Habilite a saída detalhada.

Quando nenhuma das opções de workspace é fornecida, o comando pesquisa os workspaces registrados para a implantação atual do projeto.

rayfin connector add --type <type>

Adiciona uma declaração de conector e estrutura seus arquivos de projeto.

Opção Description
--type <type> Required. Tipo de conector; usar rayfin connector types para listar tipos.
--name <name> Nome do conector; derivado do item quando omitido.
--workspace-id <id> ID de espaço de trabalho Fabric.
--item-id <id> ID do item Fabric.
--operations <ops> Subconjunto separado por vírgulas das operações permitidas.
-v, --verbose Habilite a saída detalhada.
-y, --yes Aceito confirmações automaticamente.
--json Emita saída JSON.

rayfin connector list

Lista os conectores declarados em rayfin.yml.

Opção Description
-v, --verbose Inclua metadados e capacidades do conector.
--json Emita saída JSON.

rayfin connector inspect

Inspeciona um conector configurado ou uma fonte Fabric endereçada diretamente sem fazer alterações.

Opção Description
--name <name> Nome do conector configurado.
-w, --workspace <name> Nome do espaço de trabalho para inspeção direta.
--workspace-id <id> ID do espaço de trabalho para inspeção direta.
--item <name> Nome do item para inspeção direta.
--item-id <id> ID do item para inspeção direta.
--type <type> Tipo de conector para inspeção direta.
--url <url> URL do portal de modelos semânticos; deriva os IDs de espaço de trabalho e item.
--entity <name> Entidade ou tabela para amostra; omitir com --query para listar as entidades.
--query <path> .sql ou .dax para executar em modo somente leitura.
--rows <n> Limite de linha; padrão para 10 para amostras e é limitado a 100.
-v, --verbose Habilite a saída detalhada.
--output <interactive\|plain\|json> Selecione o formato de saída.
--json Emita saída JSON.

Use --name para um conector configurado, um seletor completo de fonte direta ou --url para um modelo semântico.

rayfin connector invoke [connector-name] [operation]

Invoca uma operação em um conector configurado.

Argumento ou opção Description
[connector-name] Nome do conector configurado.
[operation] Operação de conectores, como executeQuery.
--name <name> Alternativa nomeada a [connector-name].
--operation <operation> Alternativa nomeada a [operation].
--input <json> Entrada de operação JSON.
--file <path> JSON contendo entrada de operação.
--transport <auto\|deployed> Caminho de invocação; por padrão para auto.
-v, --verbose Habilite a saída detalhada.
--output <interactive\|plain\|json> Selecione o formato de saída.
--output-file <path> Escreva o resultado completo em um arquivo.
--max-inline-bytes <bytes> Limiar de tamanho de resultado para gravar um arquivo; padrão é 1 MiB.
--json Emita saída JSON.

rayfin connector remove <name>

Remove uma declaração de conector e seus arquivos gerados de conector.

Argumento ou opção Description
<name> Required. Nome do conector para remover.
-v, --verbose Habilite a saída detalhada.
-y, --yes Aceite automaticamente a confirmação da remoção.
--json Emita saída JSON.

Comandos de funções

rayfin functions init [directory]

Estrutura e configura um pacote de Funções.

Argumento ou opção Description
[directory] Project root; por padrão para o diretório atual.
--force Sobrescreva uma estrutura de Funções existente.
--path <relative-path> Localização do pacote Functions em relação à raiz do projeto.

A localização do pacote é padrão para um local de trabalho detectado ou rayfin/functions.

Comandos de desenvolvimento

rayfin dev [project-path]

Inicia uma sessão de desenvolvimento local contra um backend Rayfin.

Argumento ou opção Description
[project-path] Project root; por padrão para o diretório atual.
--skip-db-apply Evite a configuração automática do banco de dados.
--env-file <path> .env arquivo usado para rayfin.yml interpolação.
--provider <fabric> Provedor backend; padrão para fabric.
-w, --workspace <name> Nome de espaço de trabalho Fabric para um backend de primeira execução.
--workspace-id <id> ID de espaço de trabalho Fabric para um backend de primeira execução.
--capacity-id <id> ID de capacidade Fabric para um espaço de trabalho sem capacidade utilizável.
-t, --tenant <id> ID de locatário do Microsoft Entra.
--encryption-fallback-enabled Permitir armazenamento de tokens em texto simples quando não houver chaveiro do sistema operacional disponível.
--no-emit-env Não regenere o arquivo do framework .env.local .
-v, --verbose Permite o registro detalhado.

rayfin dev functions apply

Inicia o host local de Funções contra a implantação ativa.

Opção Description
--port <port> A porta host de Funções Locais; padrão para 7071.
--inspect-port <port> Node.js porta inspetor; por padrão para 9229.
--no-debug Desative o inspetor Node.js.
--no-emit-env Não regenere o arquivo do framework .env.local .
--verbose Mostre a saída do diagnóstico.
--json Emita saída JSON.
-y, --yes Corra sem prompts interativos.

Gerenciar arquivos de agentes

O rayfin init ai-files comando gerencia arquivos de contexto do agente Rayfin no seu projeto: AGENTS.md, .mcp.json, e .agents/skills/rayfin/SKILL.md. A CLI instala esses arquivos automaticamente quando você anda um projeto. Execute os comandos abaixo para instalá-los ou atualizá-los em um projeto existente, ou verifique o status deles.

rayfin init ai-files install

Instala ou atualiza os arquivos do agente Rayfin. O comando é idempotente e preserva a configuração existente do usuário.

Opção Description
--enable <id> Instale ou mantenha um item específico pelo seu ID com namespace, como skill:rayfin. Repetível.
--disable <id> Pare de gerenciar um item específico sem deletar seu arquivo. Repetível.
--remove-files Remova o arquivo no disco ao desativar um item. Requer --disable.
--force [ids...] Sobrescreva itens modificados, restaure itens faltantes ou reconstrua os malformados .mcp.json. Aceita IDs opcionais com namespaces para escopar a operação. Nunca sobrescreve AGENTS.md.
-n, --dry-run Relate as mudanças sem precisar escrever arquivos.
--json Emitir saída estruturada como JSON; implica modo não interativo.
-y, --yes, --non-interactive Pule o prompt interativo e aceite os defaults.

Por exemplo, instalar os padrões sem que seja solicitado:

npx rayfin init ai-files install --yes

rayfin init ai-files status

Imprime o estado de cada arquivo de agente gerenciado. Use --json para saída estruturada.

Os estados possíveis incluem up-to-date, update-available, user-modified, missing, not-installed, disabled, orphaned, e unreadable. Execute rayfin init ai-files install para atualizar arquivos ou rayfin init ai-files install --force <id> sobrescrever um item gerenciado específico.

Implantar no Fabric

rayfin up

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

Argument Description
-t, --tenant <id> Use um ID específico de inquilino.
-w, --workspace <name> Implantar em um espaço de trabalho Fabric pelo nome; por padrão para My Workspace.
--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.
--item-name <name> Nome de exibição do item Fabric; padrão para o ID do projeto.
--capacity-id <id> ID de capacidade Fabric quando o workspace alvo precisa de capacidade.
--force Permitir mudanças destrutivas no esquema de dados.
-n, --dry-run Valide entradas e resolva o espaço de trabalho sem implantar.
--env-file <path> .env arquivo para propriedades de implantação; padrão para rayfin/.env.
-v, --verbose Habilite a saída detalhada.
--json Devolva a saída de implantação em formato JSON.
-y, --yes Aceito confirmações automaticamente.
--encryption-fallback-enabled Permitir armazenamento de tokens em texto simples quando não houver chaveiro do sistema operacional disponível.
--exclude-services <names> Serviços separados por vírgulas para pular durante a construção e implantação: staticHosting ou functions.
--provider <fabric> Provedor de implantação; define como padrão .fabric

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 <workspace-id> --yes

Implante sem construir ou implantar Funções:

npx rayfin up --exclude-services functions

--capacity-id Não pode ser combinado com --workspace, --workspace-id, ou --workspace-uri.

Subcommand Description
npx rayfin up db apply Gerar e aplicar a configuração do DAB ao endpoint remoto da carga de trabalho do item Rayfin.
npx rayfin up functions deploy Construa, empacote e implante Funções no item remoto ativo.
npx rayfin up staticapp deploy Construa, empacote e implante conteúdo estático no item remoto do Rayfin.
npx rayfin up connector apply Aplique a configuração do banco de dados para conectores GraphQL declarados.
npx rayfin up status Mostre o status atual da implantação.
npx rayfin up list Liste todas as implantações Fabric registradas para o projeto.
npx 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 functions deploy

Constrói, empacota e implanta Funções no item remoto ativo.

Opção Description
--verbose Mostrar a saída verbosa.
--skip-build Implante a saída existente das Funções sem construir o jogo.
--json Emita saída JSON.

rayfin up connector apply

Aplica configuração de banco de dados para conectores GraphQL declarados.

Opção Description
--name <name> Aplique apenas o conector nomeado.
--verbose Habilite a saída detalhada.
--json Emita saída 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
npx 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
  • Última atualização em