uipath-cli
latest
false
UiPath CLI user guide
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Syntax and options for `uip rpa create-project`, which scaffolds a new UiPath Studio project from a template.
uip rpa create-project scaffolds a new UiPath project from a template. The command produces a project directory with a project.json and the starter workflow files for the chosen template, ready to be opened in Studio or built with uip rpa build / uip rpa pack.
Note:
create-project is a hidden legacy alias — the current primary form shown in --help is uip rpa init.
Scaffolding is performed by Studio itself, so the command works only on Windows runners (Studio is Windows-only). On macOS or Linux, copy a template directory by hand or run scaffolding on a Windows agent earlier in the pipeline.
Synopsis
uip rpa create-project --name <name> [options]
uip rpa create-project --name <name> [options]
Options
| Flag | Description |
|---|---|
--name <string> | Required. Name of the project to create. |
--template-id <string> | Built-in template identifier — BlankTemplate, LibraryProcessTemplate, TestAutomationProjectTemplate, etc. Defaults to BlankTemplate. Run uip rpa search-templates for the live list on your Studio version. |
--location <string> | Parent directory in which the project folder is created. Defaults to a Studio-managed location. |
--description <string> | Project description, written to project.json. |
--expression-language <VisualBasic|CSharp> | Expression language for the new project. |
--target-framework <Legacy|Windows|Portable> | Target framework — Portable for cross-platform projects, Windows for Windows-only, Legacy for the .NET Framework era projects supported by uip rpa-legacy. |
--allow-prerelease-packages | Allow prerelease activity-package versions in the dependency block. |
--template-package-id <id> | NuGet package ID of a template package from a feed (overrides --template-id when set). Use uip rpa search-templates to discover available packages. |
--template-package-version <version> | Version of the template package. Latest if omitted. |
--skip-solution-registration | Do not auto-register the new project in the surrounding solution. By default, a project created inside a solution directory is registered in the enclosing .uipx; pass this to scaffold it standalone instead (solutionRegistration.Status is then OptedOut). Default: false. |
For the complete option list on your installed tool version, run:
uip rpa create-project --help
uip rpa create-project --help
Examples
# Blank cross-platform project in the current folder
uip rpa create-project --name MyProcess --target-framework Portable --location .
# Library project, C# expression language
uip rpa create-project \
--name MyLib \
--template-id LibraryProcessTemplate \
--expression-language CSharp
# Project from a feed-published template package
uip rpa create-project \
--name FromFeed \
--template-package-id MyOrg.Templates.Standard \
--template-package-version 2.4.1
# Blank cross-platform project in the current folder
uip rpa create-project --name MyProcess --target-framework Portable --location .
# Library project, C# expression language
uip rpa create-project \
--name MyLib \
--template-id LibraryProcessTemplate \
--expression-language CSharp
# Project from a feed-published template package
uip rpa create-project \
--name FromFeed \
--template-package-id MyOrg.Templates.Standard \
--template-package-version 2.4.1
Related
uip rpa search-templates— discover available template packages on configured NuGet feeds.uip rpa build— compile the new project once scaffolded.uip rpa pack— package it into a.nupkgfor upload.