Skip to content

docs: add push/pull docs to getting started #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EusebiuJecan07 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add push/pull docs to getting started #1025

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/core/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,3 +279,29 @@ Open your browser and navigate to UiPath. Go to the specified folder, where you'
```
[Echo]: Hello, World! Echo: Hello, World! Echo: Hello, World!
```
## Integrating with the UiPath Studio Web

You can synchronize your local Coded Agent project with UiPath Studio Web, enabling a dual run, debug, and evaluation experience, while code editing remains reserved for your local IDE.

The link between the local and remote project files is done based on `UIPATH_PROJECT_ID` and requires prior authorisation using the `uipath auth` command.
Copy link

@CatalinB7 CatalinB7 Dec 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i've seen american version more often

Suggested change
The link between the local and remote project files is done based on `UIPATH_PROJECT_ID` and requires prior authorisation using the `uipath auth` command.
The link between the local and remote project files is done based on `UIPATH_PROJECT_ID` and requires prior authorization using the `uipath auth` command.


It can be retrieved from new UiPath Studio Web as such: `Studio Web` -> `Create New Agent` -> `Coded Agent` Also, it can be copied from an existing Coded Agent project in Studio Web.

The `UIPATH_PROJECT_ID=****` should be added to the coded agent environment, the `.env` file.

### Synchronize the local project to Studio Web

Using the `uipath push` command you syncronize the local files to the remote Studio Web project

<!-- termynal -->
```shell
> uipath push
```
### Synchronize the remote Studio Web Coded Agent project locally

Using the `uipath pull` command you syncronize the remote Studio Web to your local project

<!-- termynal -->
```shell
> uipath pull
```
Loading