Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 41 additions & 0 deletions docs/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,3 +244,44 @@ Selected feed: Orchestrator Tenant Processes Feed
✨ Job started successfully!
🔗 Monitor your job here: [LINK]
```
---

::: mkdocs-click
:module: uipath._cli
:command: push
:depth: 1
:style: table

<!-- termynal -->

```shell
> uipath push
Pushing UiPath project to Studio Web...
Uploading 'main.py'
Uploading 'uipath.json'
Updating 'pyproject.toml'
Uploading '.uipath/studio_metadata.json'

Importing referenced resources to Studio Web project...

🔵 Resource import summary: 0 total resources - 0 created, 0 updated, 0 unchanged, 0 not found
```
---

::: mkdocs-click
:module: uipath._cli
:command: pull
:depth: 1
:style: table

<!-- termynal -->

```shell
> uipath pull
Pulling UiPath project from Studio Web...
Processing: main.py
Updated 'main.py'
Processing: uipath.json
File 'uipath.json' is up to date
✓ Project pulled successfully
```
2 changes: 2 additions & 0 deletions src/uipath/_cli/cli_auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,11 @@ def auth(
Otherwise, it can be specified with --cloud (default), --staging, or --alpha flags.

Interactive mode (default): Opens browser for OAuth authentication.

Unattended mode: Use --client-id, --client-secret, --base-url and --scope for client credentials flow.

Network options:

- Set HTTP_PROXY/HTTPS_PROXY/NO_PROXY environment variables for proxy configuration
- Set REQUESTS_CA_BUNDLE to specify a custom CA bundle for SSL verification
- Set UIPATH_DISABLE_SSL_VERIFY to disable SSL verification (not recommended)
Expand Down
10 changes: 4 additions & 6 deletions src/uipath/_cli/cli_pull.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"root",
type=click.Path(exists=False, file_okay=False, dir_okay=True, path_type=Path),
default=Path("."),
metavar="",
)
@click.option(
"--overwrite",
Expand All @@ -34,14 +35,11 @@ def pull(root: Path, overwrite: bool) -> None:

This command pulls the remote project files from a UiPath Studio Web project.

Args:
root: The root directory to pull files into
overwrite: Whether to automatically overwrite local files without prompts

Environment Variables:
**Environment Variables:**
UIPATH_PROJECT_ID: Required. The ID of the UiPath Studio Web project

Example:
**Example:**

$ uipath pull
$ uipath pull /path/to/project
$ uipath pull --overwrite
Expand Down
18 changes: 9 additions & 9 deletions src/uipath/_cli/cli_push.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,10 @@ async def upload_source_files_to_project(

@click.command()
@click.argument(
"root", type=click.Path(exists=True, file_okay=False, dir_okay=True), default="."
"root",
type=click.Path(exists=True, file_okay=False, dir_okay=True),
default=".",
metavar="",
)
@click.option(
"--ignore-resources",
Expand All @@ -232,21 +235,18 @@ def push(root: str, ignore_resources: bool, nolock: bool, overwrite: bool) -> No

This command pushes the local project files to a UiPath Studio Web project.
It ensures that the remote project structure matches the local files by:

- Updating existing files that have changed
- Uploading new files
- Deleting remote files that no longer exist locally
- Optionally managing the UV lock file

Args:
root: The root directory of the project
ignore_resources: Whether to skip importing the referenced resources
nolock: Whether to skip UV lock operations and exclude uv.lock from push
overwrite: Whether to automatically overwrite remote files without prompts
**Environment Variables:**

- `UIPATH_PROJECT_ID`: Required. The ID of the UiPath Cloud project

Environment Variables:
UIPATH_PROJECT_ID: Required. The ID of the UiPath Cloud project
**Example:**

Example:
$ uipath push
$ uipath push --nolock
$ uipath push --overwrite
Expand Down