uip maestro bpmn init

Syntax and options for `uip maestro bpmn init`, which scaffolds a new Maestro project with a valid BPMN 2.0 starter and Orchestrator metadata files.

uip maestro bpmn init scaffolds a new Maestro project directory with a valid BPMN 2.0 starter and the metadata files Orchestrator expects for process-orchestration packages. It's registered under the bpmn branch.

大纲

uip maestro bpmn init <name> [--process-id <id>] [--force] [--skip-solution-registration]

使用全局选项。退出代码遵循标准合同。

参数

• <name> （必填） — 项目文件夹名称。已验证VALID_PROJECT_NAME_REGEX ：仅限字母、数字、下划线 ( _ ) 和连字符 ( - )。

选项

选项	描述
--process-id <id>	BPMN process ID to write into the generated template. Default: Process_1.
--force	Initialize even if the target directory exists and is non-empty. Existing files are not cleared — files are written alongside; this is useful for reinitializing inside a pre-created folder.
--skip-solution-registration	Do not auto-register this project in the surrounding solution (see Behavior below).

行为

在当前工作目录中创建<name>/并写入六个文件：

文件	用途
project.uiproj	{ "Name": "<name>", "ProjectType": "ProcessOrchestration" }
operate.json	runtime 元数据 — targetFramework: "Portable" 、 contentType: "processOrchestration" 、 runtimeOptions.isAttended: false 。
entry-points.json	一个入口点指向入门版 BPMN 内的Event_start ，输入/输出架构为空。
bindings_v2.json	{ "version": "2.0", "resources": [] }。
package-descriptor.json	打包程序使用的文件清单。
<name>.bpmn	Starter BPMN containing Event_start → _Implicit_EndEvent, wired with a uipath:entryPointId extension using --process-id (default Process_1).

在写入之前，通过bpmn-moddle解析入门BPMN；如果出现结构（非 UiPath 扩展程序）警告，则该命令将失败，并显示BPMN validation failed: … 。

如果<name>已存在且非空，而且未设置--force ，则命令将失败并显示错误。

Solution auto-registration: unless --skip-solution-registration is passed, init looks for a surrounding solution. If run inside one, the new project is registered into it. If run outside any solution, a parent <name>Solution is scaffolded automatically and the project is nested inside it — this happens by default, not only when explicitly requested.

示例

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

# Set a custom BPMN process ID
uip maestro bpmn init invoice-orchestration --process-id InvoiceApproval

# Reinitialize into an existing non-empty folder
uip maestro bpmn init invoice-orchestration --force

# Scaffold standalone, without touching any surrounding solution
uip maestro bpmn init invoice-orchestration --skip-solution-registration

数据形状（--输出 json）

{
  "Code": "MaestroInit",
  "Data": {
    "Status": "Created successfully",
    "Path": "/workspace/invoice-orchestration",
    "SolutionRegistration": { "...": "registration outcome against the surrounding or newly created solution" },
    "AutoCreatedSolution": { "...": "present only when a parent <name>Solution was scaffolded automatically" },
    "ProjectArtifacts": { "...": "present only when additional project artifacts were generated" },
    "NextSteps": "present only when SolutionRegistration carries follow-up instructions"
  }
}

AutoCreatedSolution, ProjectArtifacts, and NextSteps are omitted entirely when not applicable — only Status, Path, and SolutionRegistration are always present. On failure the response carries Result: "Failure", Message, and Instructions.

另请参阅

• uip maestro bpmn pack — 打包框架内的项目
• uip maestro bpmn debug — 通过 Studio Web 运行
• uip maestro bpmn validate — 打包前验证
• Maestro 概述