UiPath CLI user guide

Last updated May 7, 2026

uip api-workflow build

uip api-workflow build compiles an API Workflow project without packaging it. Use it as a fast type/syntax gate in CI or inner-loop iteration; reach for uip api-workflow pack when you also need a .nupkg.

Synopsis

uip api-workflow build <projectPath>
uip api-workflow build <projectPath>

<projectPath> — path to the API Workflow project directory or .uip file.

Options

build takes no options beyond --help. Customize package metadata or signing through uip api-workflow pack instead.

Examples

# Build a project — fail the step on any compile error
uip api-workflow build ./my-workflow

# Capture the JSON result for downstream pipeline steps
uip api-workflow build ./my-workflow --output json
# Build a project — fail the step on any compile error
uip api-workflow build ./my-workflow

# Capture the JSON result for downstream pipeline steps
uip api-workflow build ./my-workflow --output json

Data shape (--output json)

{
  "Code": "ApiWorkflowBuild",
  "Data": { "Success": true }
}
{
  "Code": "ApiWorkflowBuild",
  "Data": { "Success": true }
}

On a compile failure, the tool exits with code 1 and emits a Failure result with build diagnostics in Instructions.

When to use build vs pack

Use case	Command
Validate a project compiles in CI before merging	`uip api-workflow build`
Produce a `.nupkg` for upload	`uip api-workflow pack`
Execute the workflow locally for a smoke test	`uip api-workflow run`

uip api-workflow pack — build and package into a .nupkg.
uip api-workflow run — execute the workflow locally.

Was this page helpful?

PREVIOUSpack

NEXTrun

UiPath CLI user guide

Synopsis​

Options​

Examples​

Data shape (--output json)​

When to use build vs pack​

Related​

See also​