Skip to content

Commit c98be64

Browse files
docs: add push/pull docs to getting started
1 parent 4a253ec commit c98be64

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

docs/core/getting_started.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,3 +279,29 @@ Open your browser and navigate to UiPath. Go to the specified folder, where you'
279279
```
280280
[Echo]: Hello, World! Echo: Hello, World! Echo: Hello, World!
281281
```
282+
## Integrating with the UiPath Studio Web
283+
284+
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.
285+
286+
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.
287+
288+
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.
289+
290+
The `UIPATH_PROJECT_ID=****` should be added to the coded agent environment, the `.env` file.
291+
292+
### Synchronize the local project to Studio Web
293+
294+
Using the `uipath push` command you syncronize the local files to the remote Studio Web project
295+
296+
<!-- termynal -->
297+
```shell
298+
> uipath push
299+
```
300+
### Synchronize the remote Studio Web Coded Agent project locally
301+
302+
Using the `uipath pull` command you syncronize the remote Studio Web to your local project
303+
304+
<!-- termynal -->
305+
```shell
306+
> uipath pull
307+
```

0 commit comments

Comments
 (0)