- Introduction
- Getting started
- Build on any canvas
- Build with Case
- Reference
- Defining case keys (system vs. external)
- Establishing task I/O and write-back contracts
- Modeling primary and secondary stages
- Triggering a case from Data Fabric
- Implementing stage-level personas and permissions
- Setting SLAs and automated escalation rules
- Configuring a rework loop (re-entry)
- Configuring and testing the Case Manager Agent (preview)
- Build with Flow
- Build with BPMN
- Operating
- Monitoring
- Optimizing
- Reference information
VS Code extension
Every command, keyboard shortcut, and setting of the UiPath Maestro extension for VS Code, and the fixes for sign-in and other common problems.
This page lists what the UiPath Maestro extension for Visual Studio Code (VS Code) offers: its commands, keyboard shortcuts, settings, and fixes for common problems. Build in VS Code describes how to install the extension, sign in, and build a process.
Commands and keyboard shortcuts
Run any command from the Command Palette (Ctrl/Cmd+Shift+P). The flow editor shortcuts apply only when a .flow file is the active editor.
Flow editor
| Command | Default keybinding |
|---|---|
| Flow: New Flow | Ctrl/Cmd+Alt+N |
| Flow: Open Flow | Ctrl/Cmd+Alt+O |
| Flow: Save Flow | Ctrl/Cmd+S |
| Flow: Save Flow As | Ctrl/Cmd+Shift+S |
| Flow: Undo | Ctrl/Cmd+Z |
| Flow: Redo | Ctrl+Y / Cmd+Shift+Z |
| Flow: Zoom In | Ctrl/Cmd+= |
| Flow: Zoom Out | Ctrl/Cmd+- |
| Flow: Reset Zoom | Ctrl/Cmd+0 |
| Flow: Fit to Screen | Ctrl/Cmd+Shift+F |
| Flow: Validate Flow | Ctrl/Cmd+Shift+V |
| Flow: Export Flow | None |
UiPath platform
| Command | Description |
|---|---|
| UiPath: Sign In | Sign in to UiPath. |
| UiPath: Sign Out | Sign out and clear the cached session. |
| UiPath: Select Environment | Choose the UiPath environment. |
| UiPath: Select Tenant | Choose the tenant or organization. |
| UiPath: Create New Project | Add a project to the solution. Choose Data Fabric to create an entity project. |
| UiPath: New File | Add a file to a project. Choose Entity File to add an entity. |
| UiPath: Add Entity File | Add another entity to an existing entity project. Available once the solution has one. |
| UiPath: Package | Build a .uipx solution from the workspace. |
| UiPath: Deploy | Upload a packaged solution to Orchestrator. |
| UiPath: Package & Deploy | Package and deploy in one step. |
| UiPath: Switch Deploy Target | Change the destination folder. |
| UiPath: Generate .env File | Write a CLI-compatible .env file. |
| UiPath: Refresh | Refresh the Connect tree. |
| UiPath: Show Output Log | Open the UiPath output channel. |
| UiPath: Getting Started | Open the Getting Started walkthrough. |
For the full set of canvas shortcuts, refer to Keyboard shortcuts.
Settings
Configure the extension in VS Code settings.
uipath.environment
The UiPath environment used when signing in. Default is cloud. An existing CLI session takes precedence if it points elsewhere.
uipath.autoActivateDeployment
Activates a solution deployment after a successful deploy. Default is true.
uipath.cli.path
An absolute path to the UiPath CLI binary (uip). Leave it empty to find uip on your PATH. Set this when the CLI is installed in a location that isn't on your PATH.
uipath.telemetry.enabled
Sends anonymized usage telemetry. Default is true. The extension also honors VS Code's global telemetry.telemetryLevel. Turning off either setting disables telemetry.
Troubleshooting
Sign-in fails
Sign-in fails when the OAuth callback port is busy or the CLI lost its session.
- Port in use. The CLI uses port
8104onlocalhostfor the callback. If a stale process holds it, free the port and sign in again. On macOS or Linux, runlsof -ti :8104 | xargs kill -9. On Windows, runnetstat -ano | findstr :8104, thentaskkill /F /PID <id>. - Stale session. Run UiPath: Sign Out, then UiPath: Sign In again to force a fresh sign-in.
- Read the log. Run UiPath: Show Output Log and check the UiPath output channel for sign-in errors.
The CLI isn't found
The extension shells out to uip. If it can't find the binary, sign-in and packaging fail.
- Confirm the CLI is installed by running
uip --versionin a terminal. - If
uipisn't on yourPATH, setuipath.cli.pathto the absolute path of the binary. - If the CLI isn't installed at all, run UiPath: Sign In and accept the install prompt, or install it manually with
npm install -g @uipath/cli. This requires Node.js and npm on yourPATH.
Remote workspaces don't see the CLI
In WSL, SSH, Codespaces, and dev container workspaces, the extension runs on the remote host, not your local machine. The uip binary must be installed on that host. A CLI installed on your local Windows or macOS machine isn't visible to the extension. Install the CLI in the remote workspace, then sign in again.
Deployment doesn't activate
By default, the extension activates a deployment after a successful deploy. If a deployment uploads but doesn't activate, confirm that uipath.autoActivateDeployment is turned on.
Next steps
- Build in VS Code: install the extension, sign in, and build a process.
- Keyboard shortcuts: shortcuts on the canvas in every environment.
- Entities in VS Code: model Data Fabric entities in the same solution.