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 598ff8f
Browse filesBrowse the repository at this point in the historyBrowse files
docs: document uipath new project types and agent frameworks
Add the missing `new` section to the CLI reference (mkdocs-click block
plus type semantics, behaviour matrix, and function/agent examples), an
--agent-framework column and Claude Agent SDK row to the coded-agents
framework table, explicit-type notes to the agents and Studio Web
quickstarts, a --type function guarantee note to the coded-functions
guide, and uipath-claude-sdk to the Studio Web package lists.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: packages/uipath/docs/cli/index.md
+55Lines changed: 55 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,6 +67,61 @@ 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. `--agent-framework` picks the framework and defaults to the one whose integration package is installed.
81
+
82
+
| Installed framework integrations |`uipath new x` (auto) |`uipath new x --type agent`|
| Claude Agent SDK |`uipath-claude-sdk`|`claude-sdk`| Claude models, Anthropic-native agent loop |
29
+
30
+
The `--agent-framework` column is the value to pass to `uipath new --type agent` when scaffolding explicitly (see the note below the Quickstart).
28
31
29
32
---
30
33
@@ -85,6 +88,14 @@ The example below uses LangChain. Swap `uipath-langchain` for the framework of y
85
88
86
89
////
87
90
91
+
/// info | Explicit project type and framework
92
+
`uipath new` defaults to `--type auto`: the installed agent framework integration claims the scaffold, which is why the commands above create an agent project. To request one explicitly — required when several framework integrations are installed in the same environment — pass the type and framework:
93
+
94
+
```shell
95
+
uipath new agent --type agent --agent-framework 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. With several integrations installed, pick one explicitly: `uipath new agent --type agent --agent-framework <framework>`.
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):
0 commit comments