You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 3e18950
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: packages/uipath/docs/cli/index.md
+60Lines changed: 60 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,66 @@ Treat `--client-secret` as a credential. In CI, prefer reading it from a secret
67
67
68
68
---
69
69
70
+
::: mkdocs-click
71
+
:module: uipath._cli
72
+
:command: new
73
+
:depth: 1
74
+
:style: table
75
+
76
+
Scaffolds a project in the current directory. `--type` selects what gets created:
77
+
78
+
-**`auto`** (default) — an installed agent framework integration (e.g. `uipath-langchain`) claims the scaffold and creates a coded agent project; with none installed, a coded function project is created.
79
+
-**`function`** — always creates a coded function project, regardless of installed integrations.
80
+
-**`agent`** — creates a coded agent project with the installed framework integration, and fails if none is installed rather than quietly creating a function project.
81
+
82
+
| Installed framework integrations |`uipath new x` (auto) |`uipath new x --type agent`|
| none | coded function project | error: install an agent framework |
85
+
| one | that framework's coded agent project | that framework's coded agent project |
86
+
| several | warns, scaffolds with the first discovered | warns, scaffolds with the first discovered |
87
+
88
+
With one framework installed there is nothing to choose, so `uipath new` uses it. With several, it warns and scaffolds with the first one discovered — pass `--agent-framework` to choose deliberately:
89
+
90
+
```shell
91
+
uipath new my-agent --type agent --agent-framework uipath-langchain
92
+
```
93
+
94
+
`--agent-framework` takes the integration package name, is only valid together with `--type agent`, and scaffolds with that framework alone. The names it accepts are the packages installed in your environment — the same ones the error above lists — so `uipath` keeps no list of its own.
95
+
96
+
Scaffold a coded function:
97
+
98
+
<!-- termynal -->
99
+
100
+
```shell
101
+
> uipath new my-function --type function
102
+
⠋ Creating new project my-function in current directory ...
103
+
✓ Created 'main.py' file.
104
+
✓ Created 'pyproject.toml' file.
105
+
✓ Created 'uipath.json' file.
106
+
💡 Initialize project: uipath init
107
+
💡 Run project: uipath run main '{"message": "Hello World!"}'
108
+
```
109
+
110
+
Scaffold a coded agent — requires the framework's integration package in the environment:
111
+
112
+
<!-- termynal -->
113
+
114
+
```shell
115
+
> uv add uipath-langchain
116
+
Resolved 42 packages in 1.2s
117
+
Installed 42 packages in 0.8s
118
+
119
+
> uipath new my-agent --type agent
120
+
⠋ Creating new agent my-agent in current directory ...
121
+
✓ Created 'main.py' file.
122
+
✓ Created 'langgraph.json' file.
123
+
✓ Created 'pyproject.toml' file.
124
+
💡 Initialize project: uipath init
125
+
💡 Run agent: uipath run agent '{"topic": "UiPath"}'
| Claude Agent SDK |`uipath-claude-sdk`| Claude models, Anthropic-native agent loop |
29
+
30
+
Installing one of these packages is what makes `uipath new` scaffold an agent. With more than one installed, name the one you want with `--agent-framework`, using the package exactly as it appears above.
28
31
29
32
---
30
33
@@ -85,6 +88,20 @@ The example below uses LangChain. Swap `uipath-langchain` for the framework of y
85
88
86
89
////
87
90
91
+
/// info | Guaranteeing an agent project
92
+
`uipath new` defaults to `--type auto`: the installed framework integration claims the scaffold, which is why the commands above create an agent project. Pass `--type agent` to make that a requirement — it fails with instructions instead of creating a function project when no framework is installed:
93
+
94
+
```shell
95
+
uipath new agent --type agent
96
+
```
97
+
98
+
With several framework integrations installed in the same environment, `uipath new` warns and uses the first one discovered; name the one you want instead with:
99
+
100
+
```shell
101
+
uipath new agent --type agent --agent-framework uipath-langchain
Copy file name to clipboardExpand all lines: packages/uipath/docs/core/functions.md
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -70,6 +70,14 @@ Use coded functions for deterministic compute steps: document extraction, ERP wr
70
70
71
71
////
72
72
73
+
/// info | Guaranteeing a function project
74
+
`uipath new` defaults to `--type auto`: when an agent framework integration (e.g. `uipath-langchain`) is installed in the environment, it scaffolds a coded agent instead of a function. Pass `--type function` to always get a coded function project:
Copy file name to clipboardExpand all lines: packages/uipath/docs/core/studio_web.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -171,6 +171,7 @@ First, install the SDK package for the framework you want to use:
171
171
# uipath-pydantic-ai - PydanticAI
172
172
# uipath-google-adk - Google ADK
173
173
# uipath-agent-framework - UiPath Agent Framework
174
+
# uipath-claude-sdk - Claude Agent SDK
174
175
> uv add uipath-langchain
175
176
Resolved 42 packages in 1.2s
176
177
Installed 42 packages in 0.8s
@@ -190,6 +191,7 @@ Installed 42 packages in 0.8s
190
191
# uipath-pydantic-ai - PydanticAI
191
192
# uipath-google-adk - Google ADK
192
193
# uipath-agent-framework - UiPath Agent Framework
194
+
# uipath-claude-sdk - Claude Agent SDK
193
195
> pip install uipath-langchain
194
196
Successfully installed uipath-langchain
195
197
```
@@ -221,9 +223,13 @@ Selected tenant: Tenant1
221
223
222
224
That's it, your agent should now be visible in Studio Web.
223
225
226
+
/// info
227
+
`uipath new` defaults to `--type auto`, which lets the installed framework integration claim the scaffold. Pass `--type agent` to require an agent project — it fails rather than creating a function project when no framework is installed. With several integrations installed, `uipath new` warns and uses the first one discovered; pick explicitly with `uipath new agent --type agent --agent-framework uipath-langchain`.
228
+
///
229
+
224
230
#### Coded Function
225
231
226
-
A coded function doesn't require an additional framework package. Authenticate, scaffold the project, and initialize it:
232
+
A coded function doesn't require an additional framework package. Authenticate, scaffold the project, and initialize it (`--type function` guarantees a functionproject even when a framework integration is installed):
Copy file name to clipboardExpand all lines: packages/uipath/pyproject.toml
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
[project]
2
2
name = "uipath"
3
-
version = "2.14.22"
3
+
version = "2.14.23"
4
4
description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
0 commit comments