- 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 maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip rpa studio start
Start a UiPath Studio instance and wait until it is ready using `uip rpa studio start`.
uip rpa studio start brings up a UiPath Studio instance and waits until it reports ready. Most uip rpa verbs that drive Studio bring up an instance on demand, so calling uip rpa studio start explicitly is rarely needed — use it when you want to warm up Studio at the beginning of a script (so the first downstream verb does not pay the startup cost) or to verify that a Studio installation is reachable.
The command is short-circuit safe: if a Studio instance already matches the resolved project directory, it is reused. Otherwise, the tool starts a new one.
Studio is Windows-only
Synopsis
uip rpa studio start [options]
uip rpa studio start [options]
This verb takes no arguments and no per-command options. Resolution behavior is controlled by the parent-level options shared by every uip rpa verb:
| Parent option | Description |
|---|---|
--project-dir <path> | Project directory used to match against running Studio instances. Defaults to the current working directory. |
--studio-dir <path> | Path to a Studio installation, when discovery cannot find one automatically. |
--timeout <seconds> | Maximum time to wait for a Studio instance to become ready. Default: 300. |
--verbose | Enable verbose logging from the IPC resolver. |
For the complete option list on your installed tool version, run:
uip rpa studio start --help
uip rpa --help
uip rpa studio start --help
uip rpa --help
Behavior
The resolution waterfall:
- Match by project directory — if a running Studio instance has the requested
--project-diropen, that instance is reused. - Idle instance — if a Studio instance is running but has no project open, the project is opened in it.
- Start a new Studio — otherwise, a new Studio process is started and polled until it reports ready.
On success, the command prints the resolved instance's process ID. The instance stays running after the command exits — uip rpa studio start does not own the lifecycle of the Studio process; closing Studio is left to the user.
Examples
# Bring up Studio for the current directory
uip rpa studio start
# Bring up Studio for a specific project
uip rpa studio start --project-dir ./MyProject
# Verbose, so you can see where the resolver is looking
uip rpa studio start --verbose
# Bring up Studio for the current directory
uip rpa studio start
# Bring up Studio for a specific project
uip rpa studio start --project-dir ./MyProject
# Verbose, so you can see where the resolver is looking
uip rpa studio start --verbose
Warm-up pattern
Other verbs auto-resolve Studio on demand, but the first one in a session pays the startup cost. To shift that cost to a setup step:
uip rpa studio start --project-dir ./MyProject
# downstream verbs reuse the warmed-up instance
uip rpa validate
uip rpa activities find --query "Click"
uip rpa studio start --project-dir ./MyProject
# downstream verbs reuse the warmed-up instance
uip rpa validate
uip rpa activities find --query "Click"
Related
uip rpa instances list— list running Studio instances visible to the resolver.