init de fluxo do uip Maestro

Sintaxe e opções para o "uip Maestro flow init", que estrutura um novo projeto de fluxo com um manifesto mínimo e arquivo ".flow" de início.

uip maestro flow init estrutura um novo diretório de projeto de fluxo com um manifesto mínimo e um arquivo inicial .flow contendo um único nó de disparo manual.

Resumo

uip maestro flow init <name> [--force] [--skip-solution-registration]

Recebe opções globais. Os códigos de saída seguem o contrato padrão.

Argumentos

• <name> necessário) — nome da pasta do projeto. Validado com VALID_PROJECT_NAME_REGEX: apenas letras, números, sublinhados (_) e hifens (-).

Opções

• --force inicializar mesmo que o diretório de destino exista e não esteja vazio. Os arquivos existentes não são limpos — os arquivos são escritos ao lado; isso é útil para reinicializar dentro de uma pasta pré-criada.
• --skip-solution-registration — não registre automaticamente este projeto na solução ao redor (consulte Comportamento abaixo).

Comportamento

O comando grava dois arquivos em <name>/:

• project.uiproj — { "Name": "<name>", "ProjectType": "Flow" }
• <name>.flow — Fluxo JSON de semente contendo:
  • Um nó inicial core.trigger.manual conectado a um entryPointIdgerado
  • A definição de nó correspondente em definitions[]
  • Vazio como edges, bindings, variables
  • Posição layout.nodes.start da tela

Registro automático da solução. A menos que --skip-solution-registration seja passado:

• Se o diretório atual já estiver dentro de uma solução, <name>/ será criado lá e registrado como um projeto no manifesto .uipx dessa solução.
• Se o diretório atual não estiver dentro de uma solução, uma solução pai chamada <name>Solution será estruturada automaticamente — o projeto de fluxo terminará aninhado em <name>Solution/<name>/, não em <name>/ no diretório atual, como uma leitura literal da síntese pode sugerir .

Se <name> já existir e não estiver vazio e --force não estiver definido, o comando falhará com um erro solicitando que o usuário passe --force.

Exemplos

# Create a new project in ./invoice-flow
uip maestro flow init invoice-flow

# Reinitialize into an existing non-empty folder (e.g. a Git repo)
uip maestro flow init invoice-flow --force

Formato dos dados (--output json)

{
  "Code": "FlowInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/my-flow-projectSolution/my-flow-project",
    "SolutionRegistration": {
      "Status": "Registered",
      "Message": "Project registered in parent solution.",
      "Solution": "/workspace/my-flow-projectSolution/my-flow-projectSolution.uipx",
      "Project": "my-flow-project/project.uiproj",
      "ProjectId": "00000000-0000-0000-0000-000000000000",
      "Instructions": "The project is listed in the parent solution manifest.
Packing or uploading the solution will sync solution resources automatically."
    },
    "AutoCreatedSolution": {
      "Name": "my-flow-projectSolution",
      "Path": "/workspace/my-flow-projectSolution",
      "SolutionFile": "/workspace/my-flow-projectSolution/my-flow-projectSolution.uipx"
    },
    "ProjectArtifacts": { "Created": true },
    "NextSteps": "The project is listed in the parent solution manifest.
Packing or uploading the solution will sync solution resources automatically."
  }
}

AutoCreatedSolution está presente apenas quando uma solução pai foi estruturada automaticamente (ou seja, o comando não foi executado dentro de uma solução existente). SolutionRegistration está totalmente ausente quando --skip-solution-registration é passado.

Na falha, Code está ausente e a resposta traz Result: "Failure", Message e Instructions.

Veja também

• uip maestro flow pack — empacotar o projeto com escopo
• uip maestro flow node — adicionar nós ao arquivo inicial .flow
• uip maestro flow registry — descubra tipos de nó a serem adicionados
• Visão geral do fluxo