CLI Reference

auth

Authenticate with UiPath Cloud Platform.

Usage:

auth [OPTIONS]

Options:

Name	Type	Description	Default
--cloud	text	Use production environment	True
--staging	text	Use staging environment	False
--alpha	text	Use alpha environment	False
-f, --force	boolean	Force new token	False
--help	boolean	Show this message and exit.	False

uipath auth⠋ Authenticating with UiPath ...
🔗 If a browser window did not open, please open the following URL in your browser: [LINK]
👇 Select tenant:
0: Tenant1
1: Tenant2
Select tenant number: 0
Selected tenant: Tenant1
✓ Authentication successful.

---

init

Create uipath.json with input/output schemas and bindings.

Usage:

init [OPTIONS] [ENTRYPOINT]

Options:

Name	Type	Description	Default
--infer-bindings / --no-infer-bindings	boolean	Infer bindings from the script.	True
--help	boolean	Show this message and exit.	False

Package requirements (bindings) are dependencies that are required by the automation package for successful execution.

For more information about package requirements, see the official documentation

Warning

The uipath init command executes your main.py file to analyze its structure and collect information about inputs and outputs.

uipath init⠋ Initializing UiPath project ...
✓ Created 'uipath.json' file.

---

run

Execute the project.

Usage:

run [OPTIONS] [ENTRYPOINT] [INPUT]

Options:

Name	Type	Description	Default
--resume	boolean	Resume execution from a previous state	False
-f, --file	path	File path for the .json input	None
--debug	boolean	Enable debugging with debugpy. The process will wait for a debugger to attach.	False
--debug-port	integer	Port for the debug server (default: 5678)	5678
--help	boolean	Show this message and exit.	False

Tip

For step-by-step debugging with breakpoints and variable inspection (supported from 2.0.66 onward):

# Install debugpy package
[uv] pip install debugpy
# Run agent with debugging enabled
uipath run [ENTRYPOINT] [INPUT] --debug

For vscode: 1. add the debug configuration in your .vscode/launch.json file. 2. Place breakpoints in your code where needed. 3. Use the shortcut F5, or navigate to Run -> Start Debugging -> Python Debugger: Attach.

Upon starting the debugging process, one should see the following logs in terminal:

🐛 Debug server started on port 5678
📌 Waiting for debugger to attach...
  - VS Code: Run -> Start Debugging -> Python Debugger: Attach
✓  Debugger attached successfully!

Warning

Depending on the shell you are using, it may be necessary to escape the input json:

Bash/ZSHWindows CMDWindows PowerShell

uipath run agent '{"topic": "UiPath"}'

uipath run agent "{""topic"": ""UiPath""}"

uipath run agent '{\"topic\":\"uipath\"}'

uipath run main.py '{"message": "test"}'[2025-04-11 10:13:58,857][INFO] {'message': 'test'}

---

pack

Pack the project.

Usage:

pack [OPTIONS] [ROOT]

Options:

Name	Type	Description	Default
--help	boolean	Show this message and exit.	False

Packages your project into a .nupkg file that can be deployed to UiPath.

Info

Default Files Included in .nupkg

By default, the following file types are included in the .nupkg file:

• .py
• .mermaid
• .json
• .yaml
• .yml

---

Including Extra Files

To include additional files, update the uipath.json file by adding a settings section. Use the following configuration format:

{
    "settings": {
        "filesIncluded": [
            "<file here>"
        ],
        "fileExtensionsIncluded": [
            "<new file extension to include (e.g., 'go')>"
        ]
    }
}

Warning

Your pyproject.toml must include:

• A description field (avoid characters: &, <, >, ", ', ;)
• Author information

Example:

description = "Your package description"
authors = [{name = "Your Name", email = "your.email@example.com"}]

uipath pack⠋ Packaging project ...
Name : test
Version : 0.1.0
Description: Add your description here
Authors : Your Name
✓ Project successfully packaged.

---

publish

Publish the package.

Usage:

publish [OPTIONS]

Options:

Name	Type	Description	Default
--tenant, -t	text	Whether to publish to the tenant package feed	False
--my-workspace, -w	text	Whether to publish to the personal workspace	False
--help	boolean	Show this message and exit.	False

Warning

To properly use the CLI for packaging and publishing, your project should include:

• A pyproject.toml file with project metadata
• A uipath.json file (generated by uipath init)
• Any Python files needed for your automation

uipath publish⠋ Fetching available package feeds...
👇 Select package feed:
0: Orchestrator Tenant Processes Feed
1: Orchestrator Personal Workspace Feed
Select feed number: 0
Selected feed: Orchestrator Tenant Processes Feed
⠸ Publishing most recent package: test.0.1.0.nupkg ...
✓ Package published successfully!

---

deploy

Pack and publish the project.

Usage:

deploy [OPTIONS] [ROOT]

Options:

Name	Type	Description	Default
--tenant, -t	text	Whether to publish to the tenant package feed	False
--my-workspace, -w	text	Whether to publish to the personal workspace	False
--help	boolean	Show this message and exit.	False

---

invoke

Invoke an agent published in my workspace.

Usage:

invoke [OPTIONS] [ENTRYPOINT] [INPUT]

Options:

Name	Type	Description	Default
-f, --file	path	File path for the .json input	None
--help	boolean	Show this message and exit.	False

uipath invoke agent '{"topic": "UiPath"}'⠴ Loading configuration ...
⠴ Starting job ...
✨ Job started successfully!
🔗 Monitor your job here: [LINK]